Skip to content
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.

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

fix examples for release command #2332

Merged
merged 1 commit into from Feb 22, 2023
Merged

fix examples for release command #2332

merged 1 commit into from Feb 22, 2023

Conversation

AndreyBozhko
Copy link
Contributor

What Changed

Examples for the release CLI command to be an array of plain objects

Why

Currently, running auto release --help fails with the following error:

/workspaces/csm/node_modules/command-line-usage/lib/section/content.js:82
      throw new Error(message)
            ^
Error: invalid input - 'content' must be a string, array of strings, or array of plain objects:

["{green $} auto release",{"desc":"Create a GitHub release over the specified commits range and using a specific version","example":"{green $} auto release --from v0.20.1 --to HEAD --use-version v0.21.0"}]
    at getContentLines (/workspaces/csm/node_modules/command-line-usage/lib/section/content.js:82:13)
    at new ContentSection (/workspaces/csm/node_modules/command-line-usage/lib/section/content.js:18:18)
    at /workspaces/csm/node_modules/command-line-usage/index.js:21:16
    at Array.map (<anonymous>)
    at Object.commandLineUsage [as default] (/workspaces/csm/node_modules/command-line-usage/index.js:17:29)
    at printUsage (/workspaces/csm/node_modules/command-line-application/src/index.ts:187:31)
    at parseCommand (/workspaces/csm/node_modules/command-line-application/src/index.ts:351:5)
    at app (/workspaces/csm/node_modules/command-line-application/src/index.ts:409:12)
    at Object.app (/workspaces/csm/node_modules/command-line-application/src/index.ts:434:22)
    at Object.parseArgs [as default] (/workspaces/csm/node_modules/auto/src/parse-args.ts:648:23)

Change Type

Indicate the type of change your pull request is:

  • documentation
  • patch
  • minor
  • major

@codecov
Copy link

codecov bot commented Feb 22, 2023

Codecov Report

Merging #2332 (449cc7c) into main (dd139e3) will decrease coverage by 0.08%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2332      +/-   ##
==========================================
- Coverage   80.67%   80.60%   -0.08%     
==========================================
  Files          69       69              
  Lines        5660     5660              
  Branches     1271     1271              
==========================================
- Hits         4566     4562       -4     
- Misses        716      717       +1     
- Partials      378      381       +3     
Impacted Files Coverage Δ
packages/cli/src/parse-args.ts 97.56% <ø> (ø)
plugins/microsoft-teams/src/index.ts 81.81% <0.00%> (-3.64%) ⬇️
plugins/slack/src/index.ts 77.71% <0.00%> (-1.81%) ⬇️
packages/core/src/git.ts 87.05% <0.00%> (+0.27%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Collaborator

@hipstersmoothie hipstersmoothie left a comment

Choose a reason for hiding this comment

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

Thanks! This is much clearer now

@hipstersmoothie hipstersmoothie merged commit fc7da59 into intuit:main Feb 22, 2023
@hipstersmoothie hipstersmoothie added the patch Increment the patch version when merged label Feb 22, 2023
@github-actions
Copy link

🚀 PR was released in v10.42.2 🚀

@github-actions github-actions bot added the released This issue/pull request has been released. label Feb 22, 2023
@AndreyBozhko AndreyBozhko deleted the fix-release-cmd branch February 22, 2023 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch Increment the patch version when merged released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants