-
Notifications
You must be signed in to change notification settings - Fork 309
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
Update release process to maintain both v2 and v1 releases #995
Merged
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
We no longer release the runner.
aeisenberg
reviewed
Mar 24, 2022
cklin
reviewed
Mar 24, 2022
Give the release script modes rather than source and target branches
cklin
approved these changes
Mar 25, 2022
aeisenberg
approved these changes
Mar 25, 2022
This was referenced Jul 7, 2023
3 tasks
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.
This PR implements a new release process to maintain both v2 and v1 releases of the CodeQL Action, both of which receive updates to the analysis and other features from
main
.The new release process is discussed in the updated
CONTRIBUTING.md
document. We perform the v2 release via amain -> v2
merge, and mergebackv2 -> main
as we did before with thev1
branch. However what's new is that we also perform av2 -> v1
merge to ensure that thev1
branch stays up to date with the latest changes while we need to continue supporting this release.Please read the backlinked internal issue for information on how this was tested, a link to the design doc, and followup work. Commit-by-commit review recommended.
Handling the
v2 -> v1
mergeThe most difficult part of this process, and one that is liable to change in the future, is how we handle conflicts between the
v2
andv1
branch during thev2 -> v1
merge. For instance, take the state just before thev2 -> v1
merge while we're backporting a new 2.1.7 release to v1:We need to address the conflict between
mergeback patch version bump to 2.1.7
andchange version number to 1.1.6
. However, this is complicated, as the version number appears in three places (package.json
,package-lock.json
, andnode_modules/.package-lock.json
) and these files could conflict in other ways (e.g. different package versions between v1 and v2).Our approach is to create a release prep branch from
v1
and revert the "change version number to 1.1.6" commit:By reverting this commit, the release prep branch will have the 2.1.6 version, which means the "mergeback patch version bump to 2.1.7" commit from v2 can be merged in unproblematically. Once this merge is done, we then update the version number to 1.1.7:
Merge / deployment checklist