Add support for artifact_id input and improve artifact selection for … #399
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for an optional artifact_id input, which allows users to explicitly specify the artifact to deploy and use it as the build version for uniqueness. Key changes include:
- Adding artifact_id extraction in the context and using it in the deployment process.
- Adjusting deployment logic to bypass metadata fetching when artifact_id is provided.
- Updating tests, action configuration, and documentation accordingly.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/internal/deployment.js | Introduces artifact_id handling in deployment logic and logging |
| src/internal/context.js | Adds artifact_id extraction from inputs |
| src/tests/internal/deployment.test.js | Adds tests to verify deployment when artifact_id is provided |
| action.yml | Updates inputs to add artifact_id |
| README.md | Documents the artifact_id behavior in deployment |
| let artifactIdToUse = this.artifactId; | ||
| let buildVersionToUse = this.buildVersion; | ||
|
|
||
| if (artifactIdToUse) { |
There was a problem hiding this comment.
Consider adding an inline comment explaining that when artifact_id is provided, artifactData is not fetched and the size check is skipped. This will clarify the intended behavior for future maintainers.
Copilot uses AI. Check for mistakes.
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.
improvements:
Adds a new input artifact_id to allow explicit deployment by artifact ID, addressing ambiguity when multiple artifacts share the same name.
If artifact_id is provided, it is used for both deployment and as the unique build version, improving reliability for reruns and special workflow events.
Updates documentation (README.md and action.yml) to describe the new input and clarify its behavior.
Adds a warning in the documentation about file modification dates being overridden by GitHub Pages.
Adds and passes tests for the new logic.
Usage Example:
If artifact_id is set, it overrides artifact_name and is used for both deployment and as the build version.
pls review and let me know