Skip to content

Commit

Permalink
Add changelog and release facilities
Browse files Browse the repository at this point in the history
  • Loading branch information
sneridagh committed Mar 4, 2024
1 parent cd0234f commit 34a00f6
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 0 deletions.
30 changes: 30 additions & 0 deletions packages/helpers/.release-it.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"plugins": {
"../scripts/prepublish.js": {}
},
"hooks": {
"after:bump": [
"pipx run towncrier build --draft --yes --version ${version} > .changelog.draft",
"pipx run towncrier build --yes --version ${version}",
"pnpm build --no-cache"
],
"after:release": "rm .changelog.draft"
},
"npm": {
"publish": false
},
"git": {
"commitArgs": ["--no-verify"],
"changelog": "pipx run towncrier build --draft --yes --version 0.0.0",
"requireUpstream": false,
"requireCleanWorkingDir": false,
"commitMessage": "Release @plone/helpers ${version}",
"tagName": "plone-helpers-${version}",
"tagAnnotation": "Release @plone/helpers ${version}"
},
"github": {
"release": true,
"releaseName": "@plone/helpers ${version}",
"releaseNotes": "cat .changelog.draft"
}
}
9 changes: 9 additions & 0 deletions packages/helpers/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# @plone/helpers Release Notes

<!-- Do *NOT* add new change log entries to this file.
You should create a file in the news directory instead.
For helpful instructions, please see:
https://6.docs.plone.org/contributing/index.html#contributing-change-log-label
-->

<!-- towncrier release notes start -->
1 change: 1 addition & 0 deletions packages/helpers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @plone/helpers
Empty file added packages/helpers/news/.gitkeep
Empty file.
33 changes: 33 additions & 0 deletions packages/helpers/towncrier.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[tool.towncrier]
filename = "CHANGELOG.md"
directory = "news/"
title_format = "## {version} ({project_date})"
underlines = ["", "", ""]
template = "../scripts/templates/towncrier_template.jinja"
start_string = "<!-- towncrier release notes start -->\n"
issue_format = "[#{issue}](https://github.com/plone/volto/issues/{issue})"

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking"
showcontent = true

[[tool.towncrier.type]]
directory = "feature"
name = "Feature"
showcontent = true

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bugfix"
showcontent = true

[[tool.towncrier.type]]
directory = "internal"
name = "Internal"
showcontent = true

[[tool.towncrier.type]]
directory = "documentation"
name = "Documentation"
showcontent = true

0 comments on commit 34a00f6

Please sign in to comment.