feat: make printing Markdown to the Terminal optional #2937
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
diogokiss
force-pushed
the
add-marked-output-options
branch
5 times, most recently
from
fff5466
to
fb4936b
Compare
ducanhpham0312
approved these changes
Nov 11, 2023
This commit adds a new configuration option called 'marked'. When set to true, the output of Semantic Release would print Markdown to the terminal, whenever supported, using the 'marked-terminal' library as usual. https://www.npmjs.com/package/marked-terminal When set to false, the output will be printed in plain text. This feature is particularly useful when the output or the command will be consumed by another Markdown renderer, like GitHub. This addresses the following issue. semantic-release#2191
This commit disables to flags that are deprecated in the 'marked-terminal' as pointed in the following issue. markedjs/marked#2793 ``` marked(): mangle parameter is enabled by default, but is deprecated since version 5.0.0, and will be removed in the future. To clear this warning, install https://www.npmjs.com/package/marked-mangle, or disable by setting `{mangle: false}`. marked(): headerIds and headerPrefix parameters enabled by default, but are deprecated since version 5.0.0, and will be removed in the future. To clear this warning, install https://www.npmjs.com/package/marked-gfm-heading-id, or disable by setting `{headerIds: false}`. ```
This commit adds a 'silent' option that disables any logging output. This is particularly useful when running with '--dry-run' in order to capture only the release notes output from Semantic Versioning without the logging messages.
diogokiss
force-pushed
the
add-marked-output-options
branch
from
fb4936b
to
1913be4
Compare
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.
This PR adds a new configuration option called 'marked'. When set to true, the output of Semantic Release would print Markdown to the terminal, whenever supported, using the 'marked-terminal' library as usual.
https://www.npmjs.com/package/marked-terminal
When set to false, the output will be printed in plain text. This feature is particularly useful when the output or the command will be consumed by another Markdown renderer, like GitHub.
This addresses the following issue.
#2191
Additionally, I'm also adding a 'silent' option that disables any logging output.
This is particularly useful when running with '--dry-run' in order to capture
only the release notes output from Semantic Versioning without the logging
messages.