Add support for CI build ID for Github Actions#116
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
what
This PR adds support for CI build ID for Github Actions.
why
Context
List of env variables in Github Actions.
GITHUB_RUN_ID- A unique number for each run within a repository. This number does not change if you re-run the workflow run.problem with GITHUB_RUN_ID - breaking change
When you retry parallel jobs in Github Actions then
GITHUB_RUN_IDstays the same. Because of this in Knapsack Pro Queue Mode the Knapsack Pro API will assume the queue was already consumed for the CI build ID (GITHUB_RUN_ID) and no tests will run.WARNING: This could accidentally make CI build green because no tests will run on retried CI build on Github Actions.
This is breaking change so we need to update the major release version after merge of this PR.
Migration path for Github Actions users - required
If you use Github Actions and Knapsack Pro Queue Mode then you must set in Github Actions environment variable:
KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true(more info). Thanks to that when you retry CI build then tests will run based on previously recorded tests. This solves problem mentioned in the previous section.