Skip to content

Commit 911a3ba

Browse files
author
José Valim
committed
Update release instructions
Signed-off-by: José Valim <[email protected]>
1 parent a1668a6 commit 911a3ba

File tree

2 files changed

+25
-13
lines changed

2 files changed

+25
-13
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ release_zip: compile
146146

147147
release_docs: docs
148148
cd ../docs
149-
rm -rf ../docs/master
150-
mv docs ../docs/master
149+
rm -rf ../docs/stable
150+
mv docs ../docs/stable
151151

152152
#==> Tests tasks
153153

RELEASE.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,40 @@
11
# Release process
22

3+
## All releases
4+
35
This document simply outlines the release process:
46

5-
1. Remove all `-dev` extension from versions (see below for all files)
7+
1. Ensure you are running on the oldest supported Erlang version
8+
9+
2. Remove all `-dev` extension from versions (see below for all files)
10+
11+
3. Ensure CHANGELOG is updated and add current date
12+
13+
4. Commit changes above with title "Release vVERSION" and generate new tag
14+
15+
5. Run `make clean test` to ensure all tests pass from scratch and the CI is green
16+
17+
6. Ensure minimum supported Hex works with new release (instructions upcoming)
618

7-
2. Ensure CHANGELOG is updated and add current date
19+
7. Push master and the new tag
820

9-
3. Commit changes above with title "Release vVERSION" and generate new tag
21+
8. Release new docs with `make release_docs`, move docs to `docs/stable` and push them
1022

11-
4. Run `make clean test` to ensure all tests pass from scratch and the CI is green
23+
9. Release new zip with `make release_zip`, push `Precompiled.zip` to GitHub Releases
1224

13-
5. Push master and the new tag
25+
10. Add the release to `elixir.csv` file in `elixir-lang/elixir-lang.github.com`
1426

15-
6. Release new docs with `make release_docs`, move docs to `docs/stable`
27+
## New vMAJOR.MINOR releases
1628

17-
7. Release new zip with `make release_zip`, push new zip to GitHub Releases, name it `Precompiled.zip`
29+
11. Create a new branch "vMAJOR.MINOR" release
1830

19-
8. Fast-forward merge master into stable branch with `git merge master --ff` and push it
31+
12. Move stable docs to `docs/vOLD-MAJOR.OLD-MINOR`
2032

21-
9. After release, bump versions, add `-dev` back and commit
33+
13. Move master docs to `docs/stable`
2234

23-
10. `make release_docs` once again and push it to `elixir-lang/docs`
35+
14. Bump versions, start new CHANGELOG, add `-dev` back and commit "Start vVERSION+1"
2436

25-
11. Add the release to `elixir.csv` file in `elixir-lang/elixir-lang.github.com`
37+
15. `make release_docs` and push it to `elixir-lang/docs`
2638

2739
## Places where version is mentioned
2840

0 commit comments

Comments
 (0)