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

Introduce --unreleased CLI option #347

Merged
merged 10 commits into from
Jan 5, 2024
Merged

Introduce --unreleased CLI option #347

merged 10 commits into from
Jan 5, 2024

Conversation

screendriver
Copy link
Collaborator

@screendriver screendriver commented Dec 30, 2023

--unreleased will generate a changelog even when it was not released. It will then include a section for unreleased changes.

  • when --unreleased was specified it is not allowed to provide a version number
  • when --unreleased was not specified a version number is mandatory (the same behaviour as it is right now)

Therefore I had to change the argument version-number from required (<version-number>) to always be optional ([version-number]) because there is no specification for having arguments optional or required depending on given options. Usually square brackets is for [optional option] and angle brackets for a <required argument>.

I also introduced better handling of potential undefined values with Maybes and used also Results instead of throwing Errors.

source/bin/pr-log.ts Outdated Show resolved Hide resolved
source/bin/pr-log.ts Outdated Show resolved Hide resolved
Copy link
Owner

@lo1tuma lo1tuma left a comment

Choose a reason for hiding this comment

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

LGTM

@screendriver screendriver merged commit c7e9c35 into main Jan 5, 2024
4 checks passed
@screendriver screendriver deleted the unreleased branch January 5, 2024 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants