@@ -6,66 +6,66 @@ releasing is a bit more involved than it would be otherwise.
66
771 . Pick the new release ` version ` .
88
9- * We follow [ Semantic Versioning] ( https://semver.org/spec/v2.0.0.html ) .
10- * Should be the current version in ` mix.exs ` with ` -dev ` removed.
9+ - We follow [ Semantic Versioning] ( https://semver.org/spec/v2.0.0.html ) .
10+ - Should be the current version in ` mix.exs ` with ` -dev ` removed.
1111
12- 1 . Begin drafting a new release.
12+ 2 . Begin drafting a new release.
1313
14- 1 . Go to https://github.com/elixir-explorer/explorer/releases .
15- 1 . Click "Draft a new release".
16- 1 . Under "Select tag", set the tag to ` v{version} ` , e.g. ` v0.11.0 ` .
17- 1 . Keep the target branch as ` main ` .
18- 1 . Click "Generate release notes".
19- 1 . Stop here. Wait until later to actually publish the release.
14+ 1 . Go to https://github.com/elixir-explorer/explorer/releases .
15+ 2 . Click "Draft a new release".
16+ 3 . Under "Select tag", set the tag to ` v{version} ` , e.g. ` v0.11.0 ` .
17+ 4 . Keep the target branch as ` main ` .
18+ 5 . Click "Generate release notes".
19+ 6 . Stop here. Wait until later to actually publish the release.
2020
21- 1 . Open a PR with any changes needed for the release. Must include:
21+ 3 . Open a PR with any changes needed for the release. Must include:
2222
23- * Updating the ` version ` in ` mix.exs `
24- * Updating the ` version ` in any other files that reference it, like
25- * ` README.md ` (multiple places)
26- * ` notebooks/exploring_explorer.livemd `
27- * Updating the ` CHANGELOG.md ` to reflect the release
28- * Use the generated release notes from earlier as a starting point.
29- * Edit the entries to follow the format from
30- https://keepachangelog.com/en/1.1.0/ .
23+ - Updating the ` version ` in ` mix.exs `
24+ - Updating the ` version ` in any other files that reference it, like
25+ - ` README.md ` (multiple places)
26+ - ` notebooks/exploring_explorer.livemd `
27+ - Updating the ` CHANGELOG.md ` to reflect the release
28+ - Use the generated release notes from earlier as a starting point.
29+ - Edit the entries to follow the format from
30+ https://keepachangelog.com/en/1.1.0/ .
3131
32- 1 . Merge the PR.
32+ 4 . Merge the PR.
3333
34- 1 . On the release draft page, click "Publish release".
34+ 5 . On the release draft page, click "Publish release".
3535
36- 1 . Publishing the release will kick off the "Build precompiled NIFs" GitHub
36+ 6 . Publishing the release will kick off the "Build precompiled NIFs" GitHub
3737 Action. Wait for this to complete.
3838
39- * It usually takes around 40-60 minutes.
39+ - It usually takes around 40-60 minutes.
4040
41- 1 . Generate the artifact checksums.
41+ 7 . Generate the artifact checksums.
4242
43- 1 . Go to your local version of Explorer.
44- 1 . Ensure you have the latest version of ` main ` (post PR merge).
45- 1 . Remove any intermediate builds by running:
46- ```
47- rm -rf native/explorer/target
48- ```
49- 1 . Download all the artifacts and generate the checksums:
50- ```
51- EXPLORER_BUILD=true mix rustler_precompiled.download Explorer.PolarsBackend.Native --all --print
52- ```
43+ 1 . Go to your local version of Explorer.
44+ 2 . Ensure you have the latest version of ` main ` (post PR merge).
45+ 3 . Remove any intermediate builds by running:
46+ ```
47+ rm -rf native/explorer/target
48+ ```
49+ 4 . Download all the artifacts and generate the checksums:
50+ ```
51+ EXPLORER_BUILD=true mix rustler_precompiled.download Explorer.PolarsBackend.Native --all --print
52+ ```
5353
54- 1 . Paste the checksums into the release description on GitHub.
54+ 8 . Paste the checksums into the release description on GitHub.
5555
56- 1. Go to the release published earlier at the top of
57- https://github.com/elixir-explorer/explorer/releases.
58- 1 . Click the "Edit" pencil icon.
59- 1 . At the bottom, paste the SHA256 contents under the heading "SHA256 of the
60- artifacts" (ensure the contents are formatted to look like code).
56+ 1. Go to the release published earlier at the top of
57+ https://github.com/elixir-explorer/explorer/releases.
58+ 2 . Click the "Edit" pencil icon.
59+ 3 . At the bottom, paste the SHA256 contents under the heading "SHA256 of the
60+ artifacts" (ensure the contents are formatted to look like code).
6161
62- 1 . Run `mix hex.publish`.
62+ 9 . Run `mix hex.publish`.
6363
64- 1. Double check the dependencies and files.
65- 1 . Enter "Y" to confirm.
66- 1 . Discard the auto-generated `.exs` file beginning with `checksum`.
64+ 1. Double check the dependencies and files.
65+ 2 . Enter "Y" to confirm.
66+ 3 . Discard the auto-generated `.exs` file beginning with `checksum`.
6767
68- 1 . Bump the version in the `mix.exs` and add the `-dev` flag to the end.
68+ 10 . Bump the version in the `mix.exs` and add the `-dev` flag to the end.
6969
70- * Example: `0.11.0` to `0.11.1-dev`.
71- * Can either open up a PR or push directly to `main`.
70+ - Example: `0.11.0` to `0.11.1-dev`.
71+ - Can either open up a PR or push directly to `main`.
0 commit comments