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

feat(publish): add --summary-file option #428

Merged
merged 1 commit into from Dec 13, 2022

Conversation

ghiscoding
Copy link
Member

@ghiscoding ghiscoding commented Dec 13, 2022

  • Outputs the packages and versions from publishing to a JSON file.

Description

As per Lerna PR 2653

When lerna publish --summary-file <path-to-file> It'll create a file to easily see what's been published and what version has been. Happy to rename --summary-file to something more meaningful

[
    {
        "packageName": "package1",
        "version": "v1.0.1-alpha"
    },
    {
        "packageName": "package2",
        "version": "v2.0.1-alpha"
    }
]

Motivation and Context

As per Lerna PR

When creating a release you don't get a definitive and easy way to see whats changed in a nice output especially if its a pre-release(canary), So added the ability to output a JSON object to a file which would look something like this. #2053

How Has This Been Tested?

Types of changes

  • Chore (change that has absolutely no effect on users)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

- Outputs the packages and versions from publishing to a JSON file.
@codecov-commenter
Copy link

Codecov Report

Merging #428 (b9593e7) into main (a291ec0) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #428      +/-   ##
==========================================
+ Coverage   97.32%   97.33%   +0.01%     
==========================================
  Files         147      147              
  Lines        4359     4373      +14     
  Branches     1011     1016       +5     
==========================================
+ Hits         4242     4256      +14     
  Misses        117      117              
Impacted Files Coverage Δ
...kages/cli/src/cli-commands/cli-publish-commands.ts 100.00% <ø> (ø)
packages/publish/src/publish-command.ts 99.09% <100.00%> (+0.04%) ⬆️

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

@ghiscoding ghiscoding merged commit 3de55ef into main Dec 13, 2022
@ghiscoding ghiscoding deleted the feat/publish-json-output-summary branch December 13, 2022 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants