-
Notifications
You must be signed in to change notification settings - Fork 38
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
Support page header setting of changelog file #18
Conversation
It is the same as the conventional-changelog-config-spec setting of standard-version.
The options are sent to the plugin, so I would expect you could use any of those options. You would need to move the header property into the I've just updated the docs with this, so thanks for raising the issue and opening this PR! |
Hope to review this PR againI want to explain two things:
ExpectThe header is only at the top of the page # Changelog
This document lists breaking changes for each major release.
See the GitHub Releases page for detailed changelogs:
[https://github.com/release-it/release-it/releases](https://github.com/release-it/release-it/releases)
## v14
- Removed `global` property from plugins. Use `this.config[key]` instead.
- Removed deprecated `npm.access` option. Set this in `package.json` instead.
## v13
- Dropped support for Node v8
- Dropped support for GitLab v11.6 and lower.
- Deprecated `scripts` are removed (in favor of [hooks](https://github.com/release-it/release-it#hooks)).
- Removed deprecated `--non-interactive` (`-n`) argument. Use `--ci` instead.
- Removed old `%s` and `[REV_RANGE]` syntax in command substitutions. Use `${version}` and `${latestTag}` instead.
RealityThe header will appear in the top of each version of content changes # Changelog
This document lists breaking changes for each major release.
See the GitHub Releases page for detailed changelogs:
[https://github.com/release-it/release-it/releases](https://github.com/release-it/release-it/releases)
## v14
- Removed `global` property from plugins. Use `this.config[key]` instead.
- Removed deprecated `npm.access` option. Set this in `package.json` instead.
# Changelog
This document lists breaking changes for each major release.
See the GitHub Releases page for detailed changelogs:
[https://github.com/release-it/release-it/releases](https://github.com/release-it/release-it/releases)
## v13
- Dropped support for Node v8
- Dropped support for GitLab v11.6 and lower.
- Deprecated `scripts` are removed (in favor of [hooks](https://github.com/release-it/release-it#hooks)).
- Removed deprecated `--non-interactive` (`-n`) argument. Use `--ci` instead.
- Removed old `%s` and `[REV_RANGE]` syntax in command substitutions. Use `${version}` and `${latestTag}` instead.
|
@webpro Hi. Why you closed this PR? This feature is very wanted. standard-version also have this logic on its side |
My apologies for understanding the issue incorrectly. Can someone please pick up this PR and also fix and add one or more tests please? GitHub says I can't re-open this PR, so please open a new one. I'll be happy to review and merge this feature. |
Why this PR
Because I need to add more custom descriptions to the header of the CHANGELOG file .
It is the same as the conventional-changelog-config-spec setting of standard-version.
What this PR fix
Increase in the configuration header is provided, at its head and applied to the document output.
Configuration samples