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

feat: add option for custom release note header #349

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

superewald
Copy link

@superewald superewald commented Jun 7, 2022

Description

Simple feature to allow adding a custom header for the release notes which is not related to the changelog itself. (As requested in #263).

Usage

You can add a custom header by providing the header option to pluginConfig.
The header option should be either:

  • a string (which is inserted at top of release notes)
  • a relative file path to a text file (useful for auto-generating the header)

The string or contents of the file will be inserted at the top of the release notes itself.

example config

From string

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    ["@semantic-release/release-notes-generator", {
      "header": "# My awesome custom header"
    }]
  ]
}

From file

  "plugins": [
    "@semantic-release/commit-analyzer",
    ["@semantic-release/release-notes-generator", {
      "header": "./my/custom/header.md"
    }]
  ]
}

@superewald superewald closed this Jun 7, 2022
@superewald superewald reopened this Jun 7, 2022
@EdieLemoine
Copy link

Can this be picked up? We'd love to have this feature.

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.

None yet

2 participants