Add ability to open generated changelog for editing. #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduces a new option to be specified: `launchEditor`. When specified,
`release-it-lerna-changelog` will generate the changelog with
`lerna-changelog` (just like it has always done) then launch the
configured editor with a temporary file. This allows the person doing
the release to customize the changelog before continuing.
There are a few valid values for `launchEditor`:
* `false` - Disables the feature.
* `true` - The `process.env.EDITOR` value will be used
* any string - This string will be used as if it were a command. In
order to interpolate the temporary file path in the string, you can
use `${file}` in your configuration.
rwjblue
force-pushed
the
add-option-to-open-changelog
branch
from
a409559
to
7dda95d
Compare
hjdivad
reviewed
Mar 9, 2020
* Add nice error when `$EDITOR` is not set properly, but `launchEditor: true` is specified. * Refactor README documentation of options to make it clearer what is allowed * Force `ava` to run serially (without this the tests run in parallel and mutate `process.env` causing failures dependent on timing). * Update `_execLernaChangelog` signature to be less nuts
|
Awesome points, thank you for reviewing! I've updated to address... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces a new option to be specified:
launchEditor. When specified,release-it-lerna-changelogwill generate the changelog withlerna-changelog(just like it has always done) then launch the configured editor with a temporary file. This allows the person doing the release to customize the changelog before continuing.There are a few valid values for
launchEditor:false- Disables the feature.true- Theprocess.env.EDITORvalue will be used${file}in your configuration.