Skip to content

feat: releaseNameTemplate and releaseBodyTemplate options#704

Merged
gr2m merged 2 commits intosemantic-release:masterfrom
halkeye:add-release-body-custom
Sep 25, 2023
Merged

feat: releaseNameTemplate and releaseBodyTemplate options#704
gr2m merged 2 commits intosemantic-release:masterfrom
halkeye:add-release-body-custom

Conversation

@halkeye
Copy link
Copy Markdown
Contributor

@halkeye halkeye commented Sep 22, 2023

I want to be able to be able to add some installation instructions and other preambles to each release. This seemed like the simplest way to do that, as well as handle #498

Copy link
Copy Markdown
Member

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great pull request, thank you! I'm okay to merge as is but have a suggestion

README.md Outdated
Comment on lines +96 to +97
| `releaseName` | A [Lodash template](https://lodash.com/docs#template) to customize the github release's name | `<%= nextverison.name %>` |
| `releaseBody` | A [Lodash template](https://lodash.com/docs#template) to customize the github release's body | `<%= nextverison.notes %>` |
Copy link
Copy Markdown
Member

@gr2m gr2m Sep 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we rename the arguments to releaseNameTemplate/releaseBodyTemplate for clarity?

Copy link
Copy Markdown
Contributor Author

@halkeye halkeye Sep 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call, updated

@halkeye halkeye force-pushed the add-release-body-custom branch from 50bf672 to e913ee5 Compare September 24, 2023 22:10
@gr2m gr2m changed the title feat: Add support for customizing release body and name feat: releaseNameTemplate and releaseBodyTemplate options Sep 24, 2023
Copy link
Copy Markdown
Member

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@gr2m gr2m enabled auto-merge (squash) September 24, 2023 22:26
@halkeye halkeye force-pushed the add-release-body-custom branch from e913ee5 to ea9d8e6 Compare September 24, 2023 23:39
@halkeye
Copy link
Copy Markdown
Contributor Author

halkeye commented Sep 25, 2023

I stupidly clicked the rebase with master, so CI will need to be re-approved sorry

@gr2m gr2m merged commit 9e2678c into semantic-release:master Sep 25, 2023
@halkeye halkeye deleted the add-release-body-custom branch September 25, 2023 23:51
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 9.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants