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

Support page header setting of changelog file #42

Merged
merged 4 commits into from
Feb 25, 2022

Conversation

lpreterite
Copy link
Contributor

Why this PR

Because I need to add more custom descriptions to the header of the CHANGELOG file .

The header set in the preset does not take effect. After passing the header settings to the plug-in during the local debugging process, the results obtained are far from expected.

This PR is reopen of PR#18

Expect

The 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.

Reality

The 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.

What this PR fix

Increase in the configuration header is provided, at its head and applied to the document output.

Configuration samples

{
  "plugins": {
    "@release-it/conventional-changelog": {
      "infile": "CHANGELOG.md",
      "header": "# 📋 更新历史 \n\n",
      "preset": {
        "name": "conventionalcommits"
      }
    }
  }
}

It is the same as the conventional-changelog-config-spec setting of standard-version.
@lpreterite lpreterite changed the title Feat/head options Support page header setting of changelog file Feb 15, 2022
@webpro webpro merged commit af66ee0 into release-it:master Feb 25, 2022
@webpro
Copy link
Contributor

webpro commented Feb 25, 2022

Thanks @lpreterite! It's released in v4.2.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