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

docs: update changelog generation info #3625

Merged
merged 1 commit into from
Mar 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,7 @@ make update-changelog VERSION=x.x.x

### How do I add multiple entries for the same PR?

Add a counter to your entry file names. For example, if you wanted to have three entries for PR `#123`, which is a fix, you'd create the
following files in [.changelog]:

```text
123.fixed.0.txt
123.fixed.1.txt
123.fixed.2.txt
```

Unfortunately, the `towncrier create` command doesn't have support for this [yet](https://github.com/twisted/towncrier/issues/474), so you
need to create the files manually.
Run `make add-changelog-entry` for each entry, picking the same PR number and change type.

### How do I add an entry with multiple PR links?

Expand Down
Loading