diff --git a/.github/README.md b/.github/README.md index 1e2ef45b..be8dae6f 100644 --- a/.github/README.md +++ b/.github/README.md @@ -131,7 +131,7 @@ This library uses [semantic versioning](http://semver.org/). For each release, t 4. Run [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG-ABLY.md](../CHANGELOG-ABLY.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-forks -p laravel-echo --since-tag ably-echo-1.0.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. + - The contents of that new file (`delta.md`) then need to be manually inserted at the top of the (https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG-ABLY.md](../CHANGELOG-ABLY.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`. 5. Commit generated [CHANGELOG-ABLY.md](../CHANGELOG-ABLY.md) file at root. 6. Make a PR against `main`.