Skip to content

Commit

Permalink
add more detail to releasing doc
Browse files Browse the repository at this point in the history
we may want more changes later after we release
tbd, for now just doing known details
  • Loading branch information
JamieDanielson committed May 24, 2024
1 parent e7daa67 commit 38c6c37
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,28 @@

Follow these steps to create a new release:

- Create a release-prep branch:
- Update version in package.json
- Update CHANGELOG for this version
- Commit, push branch, open PR, get a review of release prep changes, and merge
- Once the pull request is merged, fetch the updated main branch.
- Apply a tag for the new version on the merged commit on main: vX.Y.Z, for example v1.1.2: `git tag -a v1.1.2 -m "v1.1.2"`
- Push the new version tag: `git push origin v1.1.2`
- Use `npm version --no-git-tag-version` to update the version number using `major`, `minor`, `patch`, or the prerelease variants `premajor`, `preminor`, or `prepatch`.
For example, to bump from v1.1.1 to the next patch version:

```shell
> npm version --no-git-tag-version patch # 1.1.1 -> 1.1.2
```

- Confirm the version number update appears in package.json and package-lock.json.
- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as these two:
- `git log $(git describe --tags --abbrev=0)..HEAD --no-merges --oneline > new-in-this-release.log`
- `git log --pretty='%C(green)%d%Creset- %s | [%an](https://github.com/)'`
- Commit changes, push, and open a release preparation pull request for review.
- Once the pull request is merged, fetch the updated `main` branch.
- Apply a tag for the new version on the merged commit (e.g. `git tag -a v2.3.1 -m "v2.3.1"`)
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v2.3.1`
- Create a new release from [the Releases page](https://github.com/honeycombio/gha-buildevents/releases)
- check the "Publish this release to the GitHub Marketplace" box
- choose the version tag created above
- release title matches version number
- copy and paste the changelog entry for this version into the release description
- Update the major version tag so it points to the latest release
- with the latest release checked out locally:
- with the latest release checked out locally:

```shell
git tag -fa v1 -m "Update v1 tag"
Expand Down

0 comments on commit 38c6c37

Please sign in to comment.