ci: release without committing to main branch #1434
Conversation
This file contains 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
Committing to the master branch isn't allowed from github actions because of our branch protection rules. There's no easy way to allow github actions to bypass this. As a workaround, skip all the parts of the release that needed to commit to the repo. This means moving the version config to an environment variable, which shouldn't be an issue.
calumcalder
force-pushed
the
fix/ci-no-commit
branch
from
af75b87 to
cd229d2
Compare
jzacsh
requested changes
Feb 14, 2025
| run: | | ||
| VERSION=$(cz bump --get-next) | ||
| TAG="v${VERSION}" | ||
| git tag "${TAG}" |
There was a problem hiding this comment.
(same thread really) totally optional, just playing it extra safe:
Suggested change
| git tag "${TAG}" | |
| git tag "${TAG}" && | |
| git push origin "${TAG}" --tags && | |
| echo "version=${NEW_VERSION}" >> "$GITHUB_OUTPUT" |
| - id: tag | ||
| name: "Tag release" | ||
| run: | | ||
| VERSION=$(cz bump --get-next) |
There was a problem hiding this comment.
totally optional, just playing it extra safe with a new || exit 1 (and clarifying NEW_ as this, cz...bump CLI, is real origin of our version now):
Suggested change
| VERSION=$(cz bump --get-next) | |
| NEW_VERSION=$(cz bump --get-next) || exit 1 |
| - name: "Install commitizen" | ||
| run: pip install --user -U commitizen | ||
| - id: tag | ||
| name: "Tag release" |
There was a problem hiding this comment.
optional, to clarify we're mutating the repo's git state:
Suggested change
| name: "Tag release" | |
| name: "Release: Publish new semver Git Tag" |
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: "Install commitizen" | ||
| run: pip install --user -U commitizen |
There was a problem hiding this comment.
optional: wearing my supply-chain-debugging hat
could we add a line of --version output or something, so we have historical data on what version of commitizen is working for us (in case we're debugging a break int he future)
Suggested change
| run: pip install --user -U commitizen | |
| run: | | |
| pip install --user -U commitizen && | |
| cz version --verbose |
(looks like it self-reports its name, so don't need to add our own echo or anything to explain in our own logs)
| @@ -14,7 +14,7 @@ The action contains two jobs; one to bump the version number of the DTP packages | |||
|
|
|||
| DTP uses [Semantic Versioning](https://semver.org/) for published packages. We also enforce [Conventional Commits](https://conventionalcommits.org/) on the `master` branch through the `.github/workflows/commitlint.yml` Github action, which lets us automatically calculate version numbers. | |||
|
|
|||
| Commitizen is a tool that supports automatically incrementing SemVer version numbers based on git commit history. Our usage of Commitizen is configured in `.cz.toml`, and uses the `commitizen-tools/commitizen-action` Github action to automatically bump the package version number and to tag the new version in git. | |||
| Commitizen is a tool that supports automatically incrementing SemVer version numbers based on git commit history. Our usage of Commitizen is configured in `.cz.toml`, and is used in a Github action to automatically tag the new version in git. | |||
There was a problem hiding this comment.
Suggested change
| Commitizen is a tool that supports automatically incrementing SemVer version numbers based on git commit history. Our usage of Commitizen is configured in `.cz.toml`, and is used in a Github action to automatically tag the new version in git. | |
| Commitizen is a tool that supports automatically incrementing SemVer version numbers based on git commit history. Our usage of Commitizen is configured in `.cz.toml`, and is used in a Github action to automatically tag the new version in git and publish to maven (per "automated publishing" section of this doc). |
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.
Committing to the master branch isn't allowed from github actions because of our branch protection rules. There's no easy way to allow github actions to bypass this.
As a workaround, skip all the parts of the release that needed to commit to the repo. This means moving the version config to an environment variable, which shouldn't be an issue, and using git tags as the source of truth.