Add projects section to changelog yaml skeleton in PR template #950
+20
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
palas
requested review from
Jimbo4350,
newhoggy,
carbolymer and
a team
as code owners
palas
force-pushed
the
update-changelog-skeleton
branch
7 times, most recently
from
23575e4 to
8e81a9c
Compare
palas
force-pushed
the
update-changelog-skeleton
branch
from
8e81a9c to
bd4baa0
Compare
carbolymer
reviewed
Sep 11, 2025
| @@ -72,6 +73,18 @@ jobs: | |||
| console.error(`PR changelog has invalid type: ${changelog.type}\nExpected one, or more of: ${validTypeValues}`) | |||
| } | |||
|
|
|||
| let isProjectsValid = false; | |||
| // .filter(Boolean) is a trick that removes empty values from the array (see https://michaeluloth.com/javascript-filter-boolean/) | |||
| const validProjectsValues = execSync("ls */CHANGELOG* | cut -d/ -f1").toString().split('\n').filter(Boolean) | |||
There was a problem hiding this comment.
I think it would be better to read it from cabal.project.
There was a problem hiding this comment.
I am not sure it is better because, even though all projects are Haskell right now, we don't know that will always be the case, but they do need to have a CHANGELOG.md, for this to be useful. Also, properly parsing a .project file is pretty tricky from outside Haskell, it can be done in a hacky way, but it is not easy at all
carbolymer
reviewed
Sep 11, 2025
Co-authored-by: Mateusz Galazyn <[email protected]>
Jimbo4350
approved these changes
Sep 15, 2025
palas
force-pushed
the
update-changelog-skeleton
branch
from
631aeef to
fe51bba
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog
Context
We now have four projects within the
cardano-apirepository, and change logs for all of them are collected when a release forcardano-apiis cut. In order to make the release process easier, this PR introduces a new field in the change log dataHow to trust this PR
Check that the new skeleton makes sense, and there are no bugs introduced in the corresponding CI check.
See this related PR: input-output-hk/cardano-dev#20
Checklist