fix(defaults): add default path for readme and action for cli usage #267
Conversation
WalkthroughThe recent updates involve setting default values for command line options in a TypeScript file and modifying a GitHub Actions workflow to allow npm releases to be created from any branch, not just the Changes
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: .coderabbit.yaml
Files selected for processing (1)
- .github/workflows/create_npm_release.yml (1 hunks)
Files skipped from review due to trivial changes (1)
- .github/workflows/create_npm_release.yml
|
@copilot please rebase and fix the conflicts |
|
@Jamie-BitFlight I've opened a new pull request, #423, to work on those changes. Once the pull request is ready, I'll request review from you. |
There was a problem hiding this comment.
Pull request overview
This PR aims to improve the CLI user experience by adding default values for the action and readme path options. However, it also includes an unrelated workflow change that modifies the release process.
Key changes:
- Adds default values to CLI argument options for
pathsActionandpathsReadmein the inputs configuration - Removes branch restriction from the NPM release workflow, allowing releases from any configured branch
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/inputs.ts |
Adds default property to TypeScript type definition and sets default values for pathsAction (./action.yml) and pathsReadme (README.md) CLI options |
.github/workflows/create_npm_release.yml |
Removes the github.ref_name == 'main' condition from the npm-release job, allowing releases from all configured branches (main, next, beta, *.x) instead of only main |
| alias: ['pathsAction', 'action'], | ||
| type: 'string', | ||
| describe: 'Path to the action.yml', | ||
| default: './action.yml', |
There was a problem hiding this comment.
The default path for the action file is inconsistent with the default in action.yml. In action.yml (line 20), the default is action.yml, but here it's set to ./action.yml. While these may resolve to the same file in many cases, the explicit ./ prefix could cause issues in certain contexts or introduce inconsistency. Consider using action.yml (without the ./ prefix) to match the action.yml default exactly.
| default: './action.yml', | |
| default: 'action.yml', |
| npm-release: | ||
| needs: ["run-tests"] | ||
| if: (github.actor != 'dependabot[bot]' && github.ref_name == 'main' && !contains(github.event.head_commit.message, 'build(release)') && !contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')) | ||
| if: (github.actor != 'dependabot[bot]' && !contains(github.event.head_commit.message, 'build(release)') && !contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')) |
There was a problem hiding this comment.
This workflow change appears to be unrelated to the PR's stated purpose of adding default paths for CLI usage. The change removes the branch restriction (github.ref_name == 'main'), allowing NPM releases from any branch (main, next, beta, *.x). However, this contradicts the semantic-release configuration in package.json (lines 107-114), which only defines main, next, and alpha as release branches. This discrepancy could lead to unexpected release behavior or failed releases from branches not configured in semantic-release. Additionally, this change is not mentioned in the PR description and should either be removed or documented in a separate PR focused on release configuration changes.
Summary by CodeRabbit
Refactor
dependabot[bot].Chores