Use all recommended headers in GitHub API HTTP requests #82
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
Providing this header is recommended by the GitHub REST API documentation.
The previous "token" format works fine, but the "Bearer" format is the one used in the snippets in the GitHub REST API documentation so this format makes the code easier to understand.
Previously, the requests would use whatever version of the API is current, exposing the action to immediate breakage if GitHub released a new version of the REST API with relevant changes. GitHub provides the previous API for a minimum of 24 months after a new version is released, so pinning the REST API version used by the action via the `X-GitHub-Api-Version` HTTP header improves the stability of the action and allows the project maintainer to make a controlled migration to the new API version.
per1234
added
type: enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #82 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 745 745
=========================================
Hits 745 745 ☔ View full report in Codecov by Sentry. |
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.
See:
https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api?apiVersion=2022-11-28#headers