Skip to content

Commit

Permalink
updated since tag version number for github changelog generator
Browse files Browse the repository at this point in the history
  • Loading branch information
sacOO7 committed Aug 1, 2023
1 parent 8e2d632 commit 7fc9421
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -88,7 +88,7 @@ Starting with release 1.2, this library uses [semantic versioning](http://semver
1. Create a branch for the release, named like `release/1.2.3` (where `1.2.3` is the new version number)
2. Replace all references of the current version number with the new version number and commit the changes
3. Run [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). This may require some manual intervention, both in terms of how the command is run and how the change log file is modified. Your mileage may vary:
- The command you will need to run will look something like this: `github_changelog_generator -u ably -p ably-dotnet --since-tag 1.2.3 --output delta.md --token $GITHUB_TOKEN_WITH_REPO_ACCESS`. Generate token [here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token).
- The command you will need to run will look something like this: `github_changelog_generator -u ably -p ably-go --since-tag v1.2.3 --output delta.md --token $GITHUB_TOKEN_WITH_REPO_ACCESS`. Generate token [here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token).
- Using the command above, `--output delta.md` writes changes made after `--since-tag` to a new file
- The contents of that new file (`delta.md`) then need to be manually inserted at the top of the `CHANGELOG.md`, changing the "Unreleased" heading and linking with the current version numbers
- Also ensure that the "Full Changelog" link points to the new version tag instead of the `HEAD`
Expand All @@ -97,4 +97,4 @@ Starting with release 1.2, this library uses [semantic versioning](http://semver
6. Once the PR is approved, merge it into `main`
7. Add a tag to the new `main` head commit and push to origin such as `git tag v1.2.3 && git push origin v1.2.3`
8. Create the release on Github, from the new tag, including populating the release notes
9. Create the entry on the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/))
9. Create the entry on the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/))

0 comments on commit 7fc9421

Please sign in to comment.