-
Notifications
You must be signed in to change notification settings - Fork 345
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
Add script to update version #405
Conversation
For reference, this is the error without the PAT in the
|
Co-authored-by: Francisco <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great addition! I left some suggestions and comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed some issues with my previous suggestion
…e-version' into update-version
Co-authored-by: Martín Triay <[email protected]>
- name: Update version | ||
run: python scripts/update_version.py ${{ env.RELEASE_VERSION }} | ||
- name: Auto-commit changes | ||
uses: stefanzweifel/git-auto-commit-action@49620cd3ed21ee620a48530e81dba0d139c9cb80 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why the specific hash?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To mitigate risk. I think it's a safer play since we're using a third-party action here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you know if devs can overwrite a version name? in any case the commit hash it's more certain
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed on the certainty^ And yes, I believe devs can replace the tag in git
Co-authored-by: Martín Triay <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good! Left some comments
RELEASING.md
Outdated
> Note that the CI automatically: | ||
|
||
- Updates the SPDX identifiers and antora.yml versions with the pushed tag | ||
- Creates a release branch and adds a tag to it. This can be useful if we need to push a hot fix on top of an existing release in the case of a bug. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RELEASING.md
Outdated
``` | ||
|
||
(4) Create a release branch and add a tag to it. This branch can be useful if we need to push a hot fix on top of an existing release in the case of a bug. | ||
(2) Create a tag for the release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems a bit isolated. Should we contextualize the tag? e.g. checkout the branch to be released
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ready to me!
Co-authored-by: Martín Triay <[email protected]>
Fixes #402.
This PR proposes to add a new job to the release workflow which invokes a script that updates all the SPDX identifiers in the
src
directory as well as the version in antora.yml (forthcoming). Some things to note:test
push
events, theversion
job is skippedmain
; therefore, a Personal Access Token should be used (otherwise the commit will be rejected)