chore/automatic semver [CLI-1465]#615
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
This comment has been minimized.
This comment has been minimized.
| # Creating commits | ||
|
|
||
| Commits must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) structure. | ||
|
|
There was a problem hiding this comment.
In the CLI's CONTRIBUTING.md also says about Writing commit messages, by specifying "what" rather than "how". Maybe is worth saying it here as well.
| - name: Get Next Version | ||
| id: semver | ||
| uses: ietf-tools/semver-action@v1 | ||
| with: | ||
| token: ${{ github.token }} | ||
| branch: ${{ github.ref_name }} | ||
| minorList: feat, revert | ||
| patchList: fix | ||
| noVersionBumpBehavior: silent |
There was a problem hiding this comment.
in code-client-go the config is:
- name: Get Next Version
id: semver
uses: ietf-tools/semver-action@v1
with:
token: ${{ github.token }}
branch: main
noVersionBumpBehavior: patch
here fixes branch to main instead getting ref_name, and noVersionBumpBehavior sets to patch.
Are we sure about not following the pattern that has in code-client-go?
| - name: Create tag and Push tag | ||
| if: ${{ steps.semver.outputs.next != '' }} | ||
| run: | | ||
| git tag ${{ steps.semver.outputs.next }} | ||
| git push origin ${{ steps.semver.outputs.next }} |
There was a problem hiding this comment.
maybe have separate steps for creating tag and then pushing?
ref: https://github.com/snyk/code-client-go/blob/main/.github/workflows/release.yml
| | docs | Changes to documentation for existing features. | none | | ||
| | chore | Build, workflow and pipeline changes. | none | | ||
| | revert | Reverting a previous commit. | minor | | ||
| | BREAKING CHANGE | Commit message contains BREAKING CHANGE | major | |
There was a problem hiding this comment.
Not sure if this BREAKING CHANGE should be in this table as the others are defined at the beginning of the commit message, and BREAKING CHANGE is something that is probably in the commit's body description
|
|
||
| This runs the presenter tests with `UFM_REGEN=1`, which overwrites the expected files with the current presenter output and skips the comparison. The same effect can be achieved by flipping the `regenerateExpectedFiles` constant at the top of `internal/presenters/presenter_ufm_test.go` to `true` and running the tests directly (handy when stepping through with a debugger). Review the diff before committing. | ||
|
|
||
| # Creating commits |
There was a problem hiding this comment.
I guess this is not the main header. Maybe ## or ###?
330966d to
7ec77c2
Compare
PR Reviewer Guide 🔍
|
Description
This PR introduces SemVer release tagging workflow for this repo.
Note: When this PR is merged, the repository will bump to version: v1.0.0.