Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Feature/changelog stdout #359

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

Merged
merged 3 commits into from
Mar 8, 2021
Merged

Feature/changelog stdout #359

merged 3 commits into from
Mar 8, 2021

Conversation

woile
Copy link
Member

@woile woile commented Mar 5, 2021

Description

Include a new flag on bump to send the changelog to stdout.

This allows the incremented changelog data to be captured and sent to a file.

I decided to reuse the changelog with --dry-run when this flag is set, instead of adding a new flag on changelog.
I think this is not expensive because the changelog will only be generated for just a single release/tag.

Checklist

  • Add test cases to all the changes you introduce
  • Run ./script/format and ./script/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

A normal bump should happen + changelog to the stdout

Steps to Test This Pull Request

  1. Create a new commit.
  2. Run cz bump --changelog --changelog-to-stdout > body.md
  3. Observe body.md which should contain only the incremented changes

Additional context

Closes #225

@codecov
Copy link

codecov bot commented Mar 5, 2021

Codecov Report

Merging #359 (afc5749) into master (ed06664) will increase coverage by 0.02%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #359      +/-   ##
==========================================
+ Coverage   97.53%   97.56%   +0.02%     
==========================================
  Files          39       39              
  Lines        1340     1356      +16     
==========================================
+ Hits         1307     1323      +16     
  Misses         33       33              
Flag Coverage Δ
unittests 97.56% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
commitizen/cli.py 97.50% <ø> (ø)
commitizen/__version__.py 100.00% <100.00%> (ø)
commitizen/commands/bump.py 95.19% <100.00%> (+0.74%) ⬆️
commitizen/out.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e1c1ca8...afc5749. Read the comment docs.

Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

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

Sorry for the late review. I was a bit busy recently. This one looks good to me 😃 Let's merge it

@Lee-W Lee-W merged commit ea372e3 into master Mar 8, 2021
@Lee-W Lee-W deleted the feature/changelog-stdout branch March 8, 2021 01: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.

[Feature Request] Add command to generate only recent changelog changes
2 participants