Skip to content

Commit ab4d442

Browse files
committed
Mention bump-changelogs.sh script in RELEASING
1 parent 9c2993a commit ab4d442

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

RELEASING.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -238,16 +238,19 @@ More on that command in the section below.
238238
```
239239

240240
4. Create a PR to `master` that updates `CHANGELOG.md` files for all of the packages that
241-
have just been released. The only addition to the file should be a markdown header
242-
section with the next patch version bumped, which must bring the `CHANGELOG.md` to the
243-
state of the top level section containing a version higher than the highest one ever
244-
released. Due to concurrent nature of editing the repository it is possible that
241+
have just been released. When done manually, the only addition to the file should be a markdown header
242+
section with the next patch version bumped but prefer to use the provided convenience script `./scripts/bump-changelogs.sh`
243+
to do this automatically. This will fetch a shallow copy of [CHaP](https://github.com/intersectmbo/cardano-haskell-packages)
244+
and check if any of our most recent package versions had a release. If so, the script
245+
will bump the corresponding `CHANGELOG`s with the next patch version, which brings
246+
the state of the top level section containing a version higher than the highest one ever released.
247+
Due to concurrent nature of editing the repository it is possible that
245248
`CHANGELOG.md` have already received a version bump with a section that fits the
246-
higher version criteria, in which case nothing needs to be added. The body of the
247-
section, if added, must be empty with just one single asterisk `*`.
249+
higher version criteria, in which case nothing will be nor should be added. The body of the
250+
section, when added, should be empty with just one single asterisk `*`.
248251

249252
For example, if `cardano-ledger-core-1.20.1.1` was just released, then a new empty
250-
`1.20.1.2` section in the `CHANGELOG.md` must be added:
253+
`1.20.1.2` section in the `CHANGELOG.md` will be added by the script:
251254

252255
```markdown
253256
# Version history for `cardano-ledger-core`

0 commit comments

Comments
 (0)