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

fix(xtask): Don't quote CHANGELOG commit message. #156

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

alilleybrinker
Copy link
Member

Previously, in the "commit-changelog" step of the cargo xtask release
command, we'd wrap the commit message in quotes. Turns out this is
processed by Git in a way that means the actual commit message header
is committed wrapped in quotes, which means it won't parse as a
conventional commit, and also that it breaks rollback (because
rollback checks commit messages to ensure it doesn't actually un-commit
the wrong thing).

This commit removes the quote wrapping, which should ensure correct
parsing and avoid broken rollback.

Signed-off-by: Andrew Lilley Brinker alilleybrinker@gmail.com

Previously, in the "commit-changelog" step of the `cargo xtask release`
command, we'd wrap the commit message in quotes. Turns out this is
processed by Git in a way that means the actual commit message header
is committed wrapped in quotes, which means it won't parse as a
conventional commit, and also that it breaks rollback (because
rollback checks commit messages to ensure it doesn't actually un-commit
the wrong thing).

This commit removes the quote wrapping, which should ensure correct
parsing _and_ avoid broken rollback.

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>
@alilleybrinker alilleybrinker merged commit d4f2fd0 into main Mar 6, 2024
8 checks passed
@alilleybrinker alilleybrinker deleted the alilleybrinker/fix-changelog-commit branch March 6, 2024 18:39
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.

1 participant