fix: add GitHub context in reporter #15
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
devpow112
force-pushed
the
depowell/add-context-to-reporter
branch
from
d9a0595 to
612c6c6
Compare
This comment was marked as resolved.
This comment was marked as resolved.
devpow112
commented
Dec 21, 2023
Comment on lines
+7
to
+41
| const hasContext = () => { | ||
| const { env: { GITHUB_ACTIONS } } = process; | ||
|
|
||
| return !!GITHUB_ACTIONS; | ||
| }; | ||
|
|
||
| const getContext = () => { | ||
| if (!hasContext()) { | ||
| throw new GitHubActionsUnavailableError(); | ||
| } | ||
|
|
||
| const { env: { | ||
| GITHUB_REPOSITORY, | ||
| GITHUB_WORKFLOW_REF, | ||
| GITHUB_RUN_ID, | ||
| GITHUB_RUN_ATTEMPT, | ||
| GITHUB_HEAD_REF, | ||
| GITHUB_REF, | ||
| GITHUB_SHA | ||
| } } = process; | ||
| const [owner, repo] = GITHUB_REPOSITORY.split('/'); | ||
| const [workflowPath] = GITHUB_WORKFLOW_REF.split('@'); | ||
| const workflowRegex = new RegExp(`^${owner}/${repo}/.github/workflows/`); | ||
| const branchRef = GITHUB_HEAD_REF || GITHUB_REF; | ||
|
|
||
| return { | ||
| githubOrganization: owner, | ||
| githubRepository: repo, | ||
| githubWorkflow: workflowPath.replace(workflowRegex, ''), | ||
| githubRunId: parseInt(GITHUB_RUN_ID, 10), | ||
| githubRunAttempt: parseInt(GITHUB_RUN_ATTEMPT, 10), | ||
| gitBranch: branchRef.replace(/^refs\/heads\//i, ''), | ||
| gitSha: GITHUB_SHA | ||
| }; | ||
| }; |
There was a problem hiding this comment.
These purposefully don't use the @actions/github package since it's harder to test. This is modeled after what it does internally at global script level but within a function so testing is easier and errors are better caught.
sarahboyd
approved these changes
Dec 21, 2023
|
🎉 This PR is included in version 0.0.7 🎉 The release is available on: Your semantic-release bot 📦🚀 |
ghost
added
the
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 means that at report generation time the github context will sourced. Helps with data consistency/accuracy.