continuwuation/continuwuity

Fork 42

Introduce towncrier to help with writing better changelogs #1247

Merged

nex merged 2 commits from nex/meta/towncrier into main

2025-12-29 23:30:37 +00:00

nex commented

2025-12-28 01:02:05 +00:00

Owner

Adds the config for towncrier so that we can write changelogs easier. Inspired by Synapse's contributing guide.

Requires towncrier: pipx install towncrier

Creating a changelog for the current git tag from the existing news fragments: towncrier build --name Continuwuity --version "$(git describe --tags --abbrev=0)" --date "$(date -I)"

Adds the config for [towncrier](https://towncrier.readthedocs.io) so that we can write changelogs easier. Inspired by [Synapse's contributing guide](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). Requires towncrier: `pipx install towncrier` Creating a changelog for the current git tag from the existing news fragments: `towncrier build --name Continuwuity --version "$(git describe --tags --abbrev=0)" --date "$(date -I)"`

nex added the

Enhancement

Meta

labels

2025-12-28 01:02:05 +00:00

nex added 2 commits

2025-12-28 01:02:05 +00:00

feat(meta): Set up towncrier f41bbd7361

docs: Add information on writing changelog fragments

Documentation / Build and Deploy Documentation (pull_request) Successful in 1m0s

Details

Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m40s

Details

Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 6m25s

Details

Checks / Prek / Pre-commit & Formatting (push) Has been cancelled

Details

Documentation / Build and Deploy Documentation (push) Has been cancelled

Details

Checks / Prek / Clippy and Cargo Tests (push) Has been cancelled

Details

Release Docker Image / Build linux-arm64 (release) (push) Has been cancelled

Details

Release Docker Image / Build linux-amd64 (release) (push) Has been cancelled

Details

Release Docker Image / Create Multi-arch Release Manifest (push) Has been cancelled

Details

Release Docker Image / Build linux-amd64 (max-perf) (push) Has been cancelled

Details

Release Docker Image / Build linux-arm64 (max-perf) (push) Has been cancelled

Details

Release Docker Image / Create Max-Perf Manifest (push) Has been cancelled

Details

696a1e6a4d

nex requested review from Owners

2025-12-28 01:02:37 +00:00

nex added a new dependency

2025-12-28 01:08:43 +00:00

#1248 feat: Add pull request template

Jade commented

2025-12-29 23:12:48 +00:00

Owner

alternatively uv tool install towncrier.
Could also use https://towncrier.readthedocs.io/en/stable/pre-commit.html although I'm not sure what that does

alternatively `uv tool install towncrier`. Could also use https://towncrier.readthedocs.io/en/stable/pre-commit.html although I'm not sure what that does

nex commented

2025-12-29 23:16:00 +00:00

Author

Owner

uv smelly

although I'm not sure what that does

looks beyond what we need (we don't necessarily want a news fragment for each... commit)

uv smelly > although I'm not sure what that does looks beyond what we need (we don't necessarily want a news fragment for each... commit)

julian45 commented

2025-12-29 23:18:04 +00:00

Member

@Jade wrote in #1247 (comment):

alternatively uv tool install towncrier. Could also use https://towncrier.readthedocs.io/en/stable/pre-commit.html although I'm not sure what that does

Re: the pre-commit integration: this seems to imply that towncrier-check would do a validity check of news fragments, whereas towncrier-update would seem to build news from fragments if they weren't already incorporated... though I'm not sure if that's the correct interpretation.

@Jade wrote in https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1247#issuecomment-22453: > alternatively `uv tool install towncrier`. Could also use https://towncrier.readthedocs.io/en/stable/pre-commit.html although I'm not sure what that does Re: the pre-commit integration: [this](https://github.com/twisted/towncrier/issues/498) seems to imply that `towncrier-check` would do a validity check of news fragments, whereas `towncrier-update` would seem to build news from fragments if they weren't already incorporated... though I'm not sure if that's the correct interpretation.

Jade approved these changes

2025-12-29 23:30:20 +00:00

nex merged commit 696a1e6a4d into main

2025-12-29 23:30:37 +00:00

nex deleted branch nex/meta/towncrier

2025-12-29 23:30:38 +00:00