From 336921bb40a90d19c2595409eae17944f15f5929 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Fri, 22 Mar 2024 14:09:28 +0530 Subject: [PATCH] fixed since-tag version in readme release process --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index adb7fe8..b6e7ed5 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ This library uses [semantic versioning](http://semver.org/). For each release, t 1. Update the version number in [src/Defaults.php](./src/Defaults.php) 2. Create a new branch for the release, named like `release/1.0.0` (where `1.0.0` is what you're releasing, being the new version). 3. Run [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG.md](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-php --since-tag v1.2.35 --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-php --since-tag 1.1.9 --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`.4. Commit generated [CHANGELOG.md](./CHANGELOG.md) file.