feat: add GitHub-specific request headers #443
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
This felt a bit redundant, and this pattern will make it easier for us to add more headers more easily
We'll be using this in our fetch wrapper so let's extract it!
Also the header is now different depending on if it's in a GHA environment or not Refactoring all fetch tests to check for multiple headers
kanadgupta
deleted the
add-x-readme-source-flag-and-surface-in-rm-3551
branch
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.
🧰 Changes
Refactors and enhances our
fetchwrapper to add thex-readme-sourceheader to all requests (the value defaults tocli). If it's in a GitHub Actions environment, it'll set that header tocli-gh.Additionally, if in a GitHub Actions environment, it'll capture certain attributes about the environment and include that in the request headers as well. You can read more about all the environmental variables available to us here: https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
🧬 QA & Testing
Do tests pass? Alternatively you can go to our project's Metrics dashboard, filter for requests using the
rdme-testproject's API key, and confirm the headers show up there (at least in the most recent requests after this PR was opened) 🎉