-
Notifications
You must be signed in to change notification settings - Fork 542
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
chore: introduce script to create release #5116
Conversation
5b88926
to
76320af
Compare
|
||
if [[ $DRY_RUN_MODE == true ]]; then | ||
echo "Dry running git push" | ||
git push --dry-run origin $MAJOR_MINOR_BRANCH |
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.
question: do we want to delete the old release/${manjor}.${minor}
branch after pushing the new one?
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.
I do not think so, I believe there is value in those branches existing for a period of time after release as a target for hotfixes.
|
||
# Validate versions are the same | ||
if [[ "$CURRENT_VERSION" != "$RELEASE_VERSION" ]]; then | ||
echo "Version file version: '$CURRENT_VERSION', is not equal to RELEASE_NOTES.md version: '$RELEASE_VERSION'. Please ensure the versions are equal before continuing." |
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.
question: What would be the steps required in this scenario to rectify the issue. Can we document them, either as part of this output or externally and link to them?
76320af
to
7709a0c
Compare
Pull Request Submission
Please check the boxes once done.
The pull request must:
feat:
orfix:
, others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.Pull Request Review
All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.
Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.
For Node projects: It’s important to make sure changes in
package.json
are also affectingpackage-lock.json
correctly.If a dependency is not necessary, don’t add it.
When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.
Pull Request Approval
Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.
What does this PR do?
Introduces a script that can be used to create releases by checking for major/minor or patch changes and updating/creating branches as appropriate.
Where should the reviewer start?
Run the script
./release-scripts/create-release.sh
to create/update the release branch.How should this be manually tested?
If you want to test without creating any branches, then pass the
dry-run
arg to the./release-script/create-release.sh
script e.g../release-scripts/create-release.sh dry-run
Any background context you want to provide?
What are the relevant tickets?
Screenshots
Additional questions