Add a canPush input to manage artifact uploads
#16
Conversation
Allow conditional artifact pushing via a new `can-push` input parameter in the configuration. Update relevant logic and tests to respect this setting.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
|
Caution Review failedThe pull request is closed. WalkthroughThe changes introduce a new optional input, Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub_Action
participant Configuration
participant Artifacts
GitHub_Action->>Configuration: Read inputs (including can-push)
GitHub_Action->>Artifacts: Initiate push
Artifacts->>Configuration: Check canPush
alt canPush is true
Artifacts->>Artifacts: Perform git push
Artifacts->>GitHub_Action: Log remote messages
else canPush is false
Artifacts->>GitHub_Action: Log "Skipping pushing artifacts."
Artifacts-->>GitHub_Action: Return early
end
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
action.yml (1)
15-15: Fix grammatical error in description.The description should use "Whether" instead of "Whenever" for correct grammar.
- description: 'Whenever the assets shall be pushed' + description: 'Whether the assets shall be pushed'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
dist/index.jsis excluded by!**/dist/**
📒 Files selected for processing (4)
action.yml(1 hunks)src/configuration.ts(1 hunks)src/model/artifacts.ts(1 hunks)tests/unit/model/artifacts.test.ts(5 hunks)
🔇 Additional comments (6)
action.yml (1)
10-10: LGTM! Good backward compatibility approach.The explicit
required: falsedeclarations improve clarity, and the newcan-pushinput is well-structured with a sensible default value that maintains backward compatibility.Also applies to: 13-13, 14-17
src/configuration.ts (1)
24-26: LGTM! Consistent implementation pattern.The
canPushgetter follows the same pattern as other configuration getters and correctly handles the string-to-boolean conversion for GitHub Actions inputs.src/model/artifacts.ts (1)
59-62: LGTM! Clean conditional logic implementation.The early return pattern with informative logging is well-implemented. The conditional check correctly respects the
canPushconfiguration and provides clear feedback when artifacts pushing is skipped.tests/unit/model/artifacts.test.ts (3)
25-30: LGTM! Comprehensive mocking setup.The expanded mocking of
@actions/corefunctions provides proper test coverage for the new logging functionality.
96-119: LGTM! Thorough test coverage for conditional push behavior.The test case properly verifies both aspects of the conditional push feature:
- The push operation is skipped (git.push not called)
- The informative message is logged
This provides comprehensive coverage of the new functionality.
204-233: LGTM! Flexible test configuration approach.The refactored configuration helper functions enable easy testing of different input scenarios while maintaining clean, readable test code. The
InputsConfigurationtype and parameter handling are well-implemented.
Allow conditional artifact pushing via a new
can-pushinput parameterin the configuration. Update relevant logic and tests to
respect this setting.
Summary by CodeRabbit