Skip to content

Commit

Permalink
docs(RELEASE.md): move footnotes into steps section
Browse files Browse the repository at this point in the history
  • Loading branch information
philippschulte committed Feb 3, 2025
1 parent 14128bc commit cdc7402
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,15 @@ tell Git about your signing key.
## Steps

1. Merge all PRs intended for the release.
2. Rebase latest remote main branch locally: `git pull --rebase origin main`.
3. Ensure all analysis checks and tests are passing: `make all`.
4. Open a new PR to update CHANGELOG ([example](https://github.com/fastly/go-fastly/pull/272))<sup>[1](#note1),[2](#note2),[3](#note3)</sup>.
2. Rebase latest remote main branch locally: `git pull --rebase origin main`
3. Ensure all analysis checks and tests are passing: `make all`
4. Open a new PR to update CHANGELOG ([example](https://github.com/fastly/go-fastly/pull/272)).
- We utilize [semantic versioning](https://semver.org/) and only include relevant/significant changes within the CHANGELOG.
- Also bump `ProjectVersion` in `fastly/client.go`.
- If a major version change, then update references to the version in `go.mod` and `README.md` (also in code example tests, `./fastly/example_*_test.go`).
5. Merge CHANGELOG.
6. Rebase latest remote main branch locally: `git pull --rebase origin main`.
7. Create a new signed tag (replace `{{remote}}` with the remote pointing to the official repository i.e. `origin` or `upstream` depending on your Git workflow): `tag=vX.Y.Z && git tag -s $tag -m $tag && git push {{remote}} $tag`.
8. Copy/paste CHANGELOG into a new [draft release](https://github.com/fastly/go-fastly/releases)<sup>[4](#note4)</sup>.
6. Rebase latest remote main branch locally: `git pull --rebase origin main`
7. Create a new signed tag (replace `{{remote}}` with the remote pointing to the official repository i.e. `origin` or `upstream` depending on your Git workflow): `tag=vX.Y.Z && git tag -s $tag -m $tag && git push {{remote}} $tag`
8. Copy/paste CHANGELOG into a new [draft release](https://github.com/fastly/go-fastly/releases).
- Use the format: `vX.Y.Z - yyyy-mm-dd` for the release title.
9. Publish draft release.

## Footnotes

1. <a name="note1"></a>We utilize [semantic versioning](https://semver.org/) and only include relevant/significant changes within the CHANGELOG.
2. <a name="note2"></a>Also bump `ProjectVersion` in `fastly/client.go`.
3. <a name="note3"></a>If a major version change, then update references to the version in `go.mod` and `README.md` (also in code example tests, `./fastly/example_*_test.go`).
4. <a name="note4"></a>Use the format: `vX.Y.Z - yyyy-mm-dd` for the release title.

0 comments on commit cdc7402

Please sign in to comment.