Skip to content
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

[CZID-8624] Enforce and automate changelog updates #305

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

morsecodist
Copy link
Collaborator

This enforces developers update a changelog and automates the versioning of the changelog. When developing developers can now update the changelog with unreleased notes like:

### short-read-mngs-unreleased
- my notes

If they don't, the PR check fails. At deploy time the correct version is automatically filled in instead of unreleased.

Copy link
Contributor

@vincent-czi vincent-czi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a plan to convert over to only using the top-level CHANGELOG.md file? Because we also have # Changelog sections of the READMEs for both long-read and AMR workflows. It looks to me like this approach assumes that there is only a single changelog file for all of the workflows. If we're going to standardize on a single changelog file for all workflows in the upcoming backfill PR to get our changelogs up to date, no issue. But if that's not planned, uhhh, problems.

scripts/release.sh Outdated Show resolved Hide resolved
@@ -9,7 +9,7 @@ on:
description: major, minor, or patch
default: patch
release_notes:
description: A text message summarizing the changes in this release
description: A text message summarizing the changes in this release, only used for branch releases
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was a bit confused by this phrasing until you explained it on the team meeting. Maybe expand this a bit to say:
"A text message summarizing the changes in this release. Unused for standard major/minor/patch releases, but used for branch releases."

I'm not sure that's great, but just something clarifying that it doesn't have an expected use in "normal" release flows.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants