-
Notifications
You must be signed in to change notification settings - Fork 165
Check in CI if changelogs need a bump #5311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
86f8838
to
2e7838b
Compare
Here's a demonstration of how this will look in action: https://github.com/IntersectMBO/cardano-ledger/actions/runs/18292660765/job/52083448456 |
scripts/bump-changelogs.sh
Outdated
CHAP=./cardano-haskell-packages | ||
# Download a shallow copy of CHaP | ||
git clone --depth 1 git@github.com:IntersectMBO/cardano-haskell-packages.git $CHAP | ||
git clone --depth 1 https://github.com/IntersectMBO/cardano-haskell-packages $CHAP |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It didn't work on CI via SSH, probably because the key is not configured their, so reverting to HTTPS.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can alternatively fetch a tarball using the archive URL.
However, even better I think is to use the CHaP index file rather than the repo. Although the git repo and the package repo should never be out of step, using the index guarantees that you see exactly what Cabal sees. It also avoids having to run a script to calculate the package list from the repo state.
You can see an example of doing this in a script I added to the CHaP git repo.
I think downloading the index file may also be a little faster because it's smaller than the whole repo.
BTW, I couldn't comment on this in the review because the line isn't changed in this PR, but I think it would be better to use CABAL_FILES=$(find . -wholename '*/eras/*.cabal' -o -wholename '*/libs/*.cabal')
With CABAL_FILES=$(git ls-files 'eras/*.cabal' 'libs/*.cabal') However, this also works and is simpler: CABAL_FILES=$(git ls-files '*.cabal') |
Co-authored-by: teodanciu <[email protected]>
Co-authored-by: Neil Mayhew <[email protected]>
a5cec43
to
7b233b8
Compare
## 1.1.2.1 | ||
|
||
* | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing this section is not correct. So, this change is here to test whether this new CI check works correctly or not, right?
Description
This PR adds a simple safeguard to CI that checks if
CHANGELOG
s need bumping, using our existingbump-changelogs.sh
script.Checklist
CHANGELOG.md
files updated for packages with externally visible changes.NOTE: New section is never added with the code changes. (See RELEASING.md).
.cabal
andCHANGELOG.md
files when necessary, according to theversioning process.
.cabal
files updated when necessary.NOTE: If bounds change in a cabal file, that package itself must have a version increase. (See RELEASING.md).
scripts/fourmolize.sh
).scripts/cabal-format.sh
).scripts/gen-cddl.sh
)hie.yaml
updated (usescripts/gen-hie.sh
).