Skip to content

feat(version): add --skip-bump-only-release to avoid empty gh releases#555

Merged
ghiscoding merged 2 commits intonextfrom
feat/skip-bump-only-release
Apr 13, 2023
Merged

feat(version): add --skip-bump-only-release to avoid empty gh releases#555
ghiscoding merged 2 commits intonextfrom
feat/skip-bump-only-release

Conversation

@ghiscoding
Copy link
Copy Markdown
Member

@ghiscoding ghiscoding commented Apr 9, 2023

Description

When using independent mode, a GitHub/GitLab release is created for each package and very often some of the package will only have a "Version bump only for package x" added to the changelog and a release is created even for these simple bump only package. However these kind of release are not very useful and could be skipped, this is what this option flag will provide to the user when the package is detected to be a version bump only, with this flag enabled, it will not create a release for that package

Note this will be available only under the new major v2.0.0 version and higher of Lerna-Lite

Motivation and Context

Avoid creating too many releases with info that are not that useful, most users are interested in "what changed?" and not so much in "nothing changed in package x"

How Has This Been Tested?

unit tests only

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.

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 9, 2023

Codecov Report

❗ No coverage uploaded for pull request base (next@45eb219). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             next     #555   +/-   ##
=======================================
  Coverage        ?   97.93%           
=======================================
  Files           ?      160           
  Lines           ?    12433           
  Branches        ?     2030           
=======================================
  Hits            ?    12175           
  Misses          ?      257           
  Partials        ?        1           

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

@ghiscoding
Copy link
Copy Markdown
Member Author

ghiscoding commented Apr 9, 2023

@StarpTech I believe this PR and feature could be useful to your project and it could be nice to have a review if you get a chance. I'm not using the independent mode but I assume that the unit tests I provided should be sufficient. Also note that this new option will only be merged to the version v2.0 of Lerna-Lite which I just released an alpha version couple days ago (see v2.0.0-alpha).

@ghiscoding ghiscoding changed the title feat(version): add --skip-bump-only-release to avoid empty gh releases WIP - feat(version): add --skip-bump-only-release to avoid empty gh releases Apr 9, 2023
@ghiscoding ghiscoding changed the title WIP - feat(version): add --skip-bump-only-release to avoid empty gh releases feat(version): add --skip-bump-only-release to avoid empty gh releases Apr 9, 2023
@ghiscoding ghiscoding force-pushed the feat/skip-bump-only-release branch from 72503e5 to 378c33a Compare April 13, 2023 03:49
@ghiscoding ghiscoding force-pushed the feat/skip-bump-only-release branch from f71006d to f230af3 Compare April 13, 2023 05:31

### `--skip-bump-only-release`

When this option is enabled and a package version is only being bumped without any conventional commits detected, the GitHub/GitLab release will be skipped. This will avoid creating releases with only "Version bump only for package x" in the release notes, however please note that each changelog will still be updated the version bump only text.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

typo, it should be "are still going to be updated with the "version bump only" text."

@ghiscoding ghiscoding merged commit e93e6fd into next Apr 13, 2023
@ghiscoding ghiscoding deleted the feat/skip-bump-only-release branch April 13, 2023 22:35
@StarpTech
Copy link
Copy Markdown
Contributor

Hi @ghiscoding, thank you for the update. Unfortunately, I had no time to test it.

@ghiscoding
Copy link
Copy Markdown
Member Author

@StarpTech no problem, it should be ok and it's now released under v2.0.0

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.

2 participants