Skip to content

Commit 47ee8e4

Browse files
authored
Support chore type for Towncrier (#2099)
See plone/volto#8401 (comment)
1 parent d0ba3f2 commit 47ee8e4

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

docs/contributing/index.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ To create a change log entry or news item, create a file in the `news` directory
100100

101101
For Volto, its repository is in a monorepo structure, consisting of several packages in the `packages` folder.
102102
Thus for Volto and its packages, change log entries should be created in `packages/PACKAGE_NAME/news/`, which is the root of the package.
103-
When making a change to its documentation, set up, continuous integration, or other repository-wide items, place a change log entry in `packages/volto/news/` as a default.
103+
When making a change to its documentation, setup, continuous integration, or other repository-wide items, place a change log entry in `packages/volto/news/` as a default.
104104

105105
The change log entry's format must be `###.type`, where `###` is the referenced GitHub issue or pull request number, `.` is the literal extension delimiter, and `type` is one of the following strings.
106106

@@ -109,8 +109,25 @@ The change log entry's format must be `###.type`, where `###` is the referenced
109109
- `documentation` for documentation
110110
- `feature` for new features
111111
- `internal` for internal changes
112+
- `chore` for routine tasks that shouldn't be published in the change log, but will satisfy the status checks for the presence of a change log entry
112113

113-
A package configures the types it allows in a file `towncrier.toml` located at the root of its package directory.
114+
A package configures the types it allows in a file {file}`towncrier.toml` located at the root of its package directory.
115+
116+
To avoid a filename conflict with an existing file or another pull request for the same issue number, append a period (`.`) and an integer to the filename, incrementing it as needed to make the entire filename unique.
117+
118+
```text
119+
1158.documentation
120+
1158.documentation.1
121+
1158.documentation.2
122+
```
123+
124+
For orphan change log entries—that is, those that don't need to be linked to any issue ID or other identifier—start the file name with `+`.
125+
Orphan change log entries are _always_ included in the change log, even if it's a `chore` type, as they're considered to be important enough to be published in the change log
126+
They'll be included at the end of the category corresponding to the file name's extension.
127+
128+
```text
129+
+anything.bugfix
130+
```
114131

115132

116133
(write-a-good-change-log-entry-label)=

0 commit comments

Comments
 (0)