Skip to content

fix(defaults): add default path for readme and action for cli usage #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jamie-BitFlight wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(defaults): add default path for readme and action for cli usage #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73f281e
fix(defaults): add default path for readme and action for cli usage
Jamie-BitFlight Nov 19, 2023
4f62514
fix(defaults): fix npm release blockage
Jamie-BitFlight Nov 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/create_npm_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ jobs:

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'))
Copy link

Copilot AI Dec 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
name: Release NPM build
runs-on: ubuntu-latest
permissions:
Expand Down
3 changes: 3 additions & 0 deletions src/inputs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export type ArgvOptionProperties = {
describe: string;
parseValues?: boolean;
type?: string;
default?: string;
};
};
/**
Expand Down Expand Up @@ -73,6 +74,7 @@ argvOptions[ConfigKeys.pathsAction] = {
alias: ['pathsAction', 'action'],
type: 'string',
describe: 'Path to the action.yml',
default: './action.yml',
Copy link

Copilot AI Dec 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
default: './action.yml',
default: 'action.yml',

Copilot uses AI. Check for mistakes.
};

/**
Expand All @@ -85,6 +87,7 @@ argvOptions[ConfigKeys.pathsReadme] = {
alias: ['pathsReadme', 'readme'],
type: 'string',
describe: 'Path to the README file',
default: 'README.md',
};

/**
Expand Down