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

DEV: Ensure the REL commit message is consistently created #2125

Closed
MartinThoma opened this issue Aug 28, 2023 · 0 comments · Fixed by #2126
Closed

DEV: Ensure the REL commit message is consistently created #2125

MartinThoma opened this issue Aug 28, 2023 · 0 comments · Fixed by #2126
Labels
is-feature A feature request Meta

Comments

@MartinThoma
Copy link
Member

MartinThoma commented Aug 28, 2023

Any commit message starting with REL: should have the structure:

REL: {{ semantic_version }}

## What's new

{{ CHANGELOG_ENTRY of that version}}

Desired Workflow

In order to create the release (REL) commit, I run:

  1. Run python make_release.py (currently: make_changelog.py). This (1) creates the changelog in an interactive way (2) bumps the version and (3) creates a (.gitignore-d) file RELEASE_COMMIT_MSG.md.
  2. Run git commit -eF RELEASE_COMMIT_MSG.md && git push
  3. The git tag is created by CI.

Acceptance Criteria

Alternatives

I thought about using a prepare-commit-msg git hook (docs), but that seems more complicated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is-feature A feature request Meta
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant