feat: add ability to unset GITHUB_ACTION env var #225
+12
−2
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
Signed-off-by: David van der Spek <david.vanderspek@flyrlabs.com>
|
I will merge this feature into the main branch. Before doing so, can you describe the usage scenario of this parameter in the README file? |
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.
Type of Change
Resolves
Describe Changes
This PR adds the ability to unset the
GITHUB_ACTIONSenvironment variable. In a number of scenarios it can be useful to validate a PR being merged to a branch will result in a valid release. However, due to the way the detection works in env-ci it will always pick up the branch from GitHub from environment variables that can't be overridden, even when settingci: false. Removing theGITHUB_ACTIONSenvironment variable allows semantic release to pickup the branch from Git. This allows for a workflow to checkout the base branch of a PR, do a dummy merge of the PR and then run semantic release in dry-run mode to ensure a valid release would be created if the PR is merged. Such a workflow can be very helpful in environments where pre-commit hooks aren't easy to implement or desirable like open source projects.