Repository navigation
ci: make release commit conventional and ignore optic PR title - #8
Merged
Merged
Conversation
The optic-release-automation release commit defaulted to 'Release {version}'
which fails commitlint (type-empty, subject-empty). Set commit-message to
'chore(release): {version}'. Also ignore the action's hardcoded
'[OPTIC-RELEASE-AUTOMATION]' PR title so a squash-merge can't break the
push-time lint on main.
Merged
This branch had an error being deployed
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
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.
Problem
The release workflow failed commitlint on the auto-generated release commit:
optic-release-automation-actiondefaults its releasecommit-messagetoRelease {version}, which is not a conventional commit. Both commitlint jobs (commitlintandpr-title, which lints the PR's commits) flag it.Fix
release.yml— setcommit-message: 'chore(release): {version}'so the release commit becomeschore(release): vX.Y.Z(valid, and idiomatic for standard-version).commitlint.config.mjs— ignore the action's hardcoded[OPTIC-RELEASE-AUTOMATION]PR title (not configurable in the action), so a squash-merge of the release PR can't break the push-time lint onmain.Notes
Verified locally with commitlint: the new commit passes, the bot title is ignored, and
Release v0.0.1still fails.The currently-open release PR #7 has the bad commit baked in and will be cleaned up separately (close PR, delete
release/v0.0.1branch + draft release), then a fresh release re-triggered after this merges.