Update Release + Versioning #65
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
There was a problem hiding this comment.
PR Overview
This PR updates the release and versioning mechanism by introducing a dedicated src/version.js file to define the version constant and injecting it into user-agent strings for API calls.
- Introduces tests in tests/version.test.js that validate the version format with a regex.
- Exports a version constant from src/version.js and updates user-agent strings in src/main.js and src/functions/post.js with the version information.
Reviewed Changes
| File | Description |
|---|---|
| tests/version.test.js | Adds tests to validate version strings conform to expected formats. |
| src/version.js | Defines the VERSION constant, with updated version comments and examples. |
| src/main.js | Imports VERSION and logs it, and includes it in the octokit user-agent. |
| src/functions/post.js | Updates octokit instantiation to include the new VERSION in the user-agent. |
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
src/main.js:18
- Consider adding tests to verify that the user-agent string is logged correctly, as well as checking that it is formed as expected when the VERSION changes.
core.info(`🛸 github/command ${COLORS.info}${VERSION}${COLORS.reset}`)
src/main.js:31
- Consider adding tests to confirm that the octokit client is configured with the correct user-agent, particularly ensuring the VERSION is correctly appended.
userAgent: `github/command@${VERSION}`,
src/functions/post.js:42
- Consider adding tests to verify that the user-agent is correctly set in the octokit client within this module, ensuring consistency with the versioning change.
userAgent: `github/command@${VERSION}`,
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
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 pull request updates the way this Action gets released by using a
src/version.jsfile containing the version (same as withgithub/branch-deploy). It also includes the project name and version via a user-agent when making API requests.