feat(@actions/github): added refName and refType to context#2440
Open
fearphage wants to merge 2 commits into
Open
feat(@actions/github): added refName and refType to context#2440fearphage wants to merge 2 commits into
@actions/github): added refName and refType to context#2440fearphage wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends the @actions/github runtime context by exposing two additional default GitHub Actions environment variables (GITHUB_REF_NAME and GITHUB_REF_TYPE) as context.refName and context.refType, making ref metadata easier to consume without manual env parsing.
Changes:
- Added
refNametoContext, populated fromprocess.env.GITHUB_REF_NAME. - Added
refTypetoContext, populated fromprocess.env.GITHUB_REF_TYPE.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
43
to
+47
| this.eventName = process.env.GITHUB_EVENT_NAME as string | ||
| this.sha = process.env.GITHUB_SHA as string | ||
| this.ref = process.env.GITHUB_REF as string | ||
| this.refName = process.env.GITHUB_REF_NAME as string | ||
| this.refType = process.env.GITHUB_REF_TYPE as string |
|
Needs 404 error page fixed before approval |
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
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.
Summary
refNameexposingGITHUB_REF_NAMEenvironment variablerefTypeexposingGITHUB_REF_TYPEenvironment variableBackground
Both of the environment variables are documented in the default environment variables section:
GITHUB_REF_NAMEfeature-branch-1.For pull requests that were not merged, the format is
<pr_number>/merge.GITHUB_REF_TYPEbranchortag.Source: https://docs.github.com/en/actions/reference/workflows-and-actions/variables#default-environment-variables
Note
I didn't see any unit tests related to these data values. Let me know if I missed anything.