Skip to content

Update list of changelogs #2232

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.

Sign up for GitHub

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

Merged
matthew-white merged 5 commits into from
Sep 17, 2026
Merged

Update list of changelogs #2232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c8d5a45
Update list of changelogs
matthew-white Sep 12, 2026
18de6ea
Change "Frontend" to "User interface"
matthew-white Sep 15, 2026
e6cad65
Move API below user interface
matthew-white Sep 15, 2026
d477d56
Add note about structure of frontend changelog
matthew-white Sep 15, 2026
ab69c7c
Make same changes to patch_release.md
matthew-white Sep 17, 2026
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
14 changes: 8 additions & 6 deletions .github/ISSUE_TEMPLATE/patch_release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,14 @@ Releasing requires two people: one person to push PRs and complete other tasks a
For a detailed list of technical updates, fixes, and improvements, please review the specific changelogs below:

<!-- CHANGELOG section anchors drop dots from the version number: 0.25.0 → #0250 -->
* [back-end](https://github.com/getodk/central-backend/blob/master/docs/api.yaml)
* [apps/central](https://github.com/getodk/central-frontend/tree/master/apps/central/CHANGELOG.md#<version-without-dots>)
* [apps/forms](https://github.com/getodk/central-frontend/tree/master/apps/forms/CHANGELOG.md#<version-without-dots>)
* [packages/web-forms](https://github.com/getodk/central-frontend/blob/master/packages/web-forms/CHANGELOG.md#<version-without-dots>)
* [packages/xforms-engine](https://github.com/getodk/central-frontend/blob/master/packages/xforms-engine/CHANGELOG.md#<version-without-dots>)
* [packages/xpath](https://github.com/getodk/central-frontend/tree/master/packages/xpath/CHANGELOG.md#<version-without-dots>)
* User interface
* The user interface is made up of multiple component parts; each has its own changelog.
* [apps/central](https://github.com/getodk/central-frontend/tree/master/apps/central/CHANGELOG.md#<version-without-dots>)
* [apps/forms](https://github.com/getodk/central-frontend/tree/master/apps/forms/CHANGELOG.md#<version-without-dots>)
* [packages/web-forms](https://github.com/getodk/central-frontend/blob/master/packages/web-forms/CHANGELOG.md#<version-without-dots>)
* [packages/xforms-engine](https://github.com/getodk/central-frontend/blob/master/packages/xforms-engine/CHANGELOG.md#<version-without-dots>)
* [packages/xpath](https://github.com/getodk/central-frontend/tree/master/packages/xpath/CHANGELOG.md#<version-without-dots>)
* [API](https://docs.getodk.org/central-api-changelog/)
* [Operations infrastructure](https://github.com/getodk/central/blob/master/CHANGELOG.md#<version-without-dots>)
```

Expand Down
14 changes: 8 additions & 6 deletions .github/ISSUE_TEMPLATE/release.md
View file
Open in desktop

@matthew-white matthew-white Sep 12, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I recommend hiding white space when viewing this diff.

Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,14 @@ Releasing requires two people: one person to push PRs and complete other tasks a
For a detailed list of technical updates, fixes, and improvements, please review the specific changelogs below:

<!-- CHANGELOG section anchors drop dots from the version number: 0.25.0 → #0250 -->
* [back-end](https://github.com/getodk/central-backend/blob/master/docs/api.yaml)
* [apps/central](https://github.com/getodk/central-frontend/tree/master/apps/central/CHANGELOG.md#<version-without-dots>)
* [apps/forms](https://github.com/getodk/central-frontend/tree/master/apps/forms/CHANGELOG.md#<version-without-dots>)
* [packages/web-forms](https://github.com/getodk/central-frontend/blob/master/packages/web-forms/CHANGELOG.md#<version-without-dots>)
* [packages/xforms-engine](https://github.com/getodk/central-frontend/blob/master/packages/xforms-engine/CHANGELOG.md#<version-without-dots>)
* [packages/xpath](https://github.com/getodk/central-frontend/tree/master/packages/xpath/CHANGELOG.md#<version-without-dots>)
* User interface
* The user interface is made up of multiple component parts; each has its own changelog.
* [apps/central](https://github.com/getodk/central-frontend/tree/master/apps/central/CHANGELOG.md#<version-without-dots>)
* [apps/forms](https://github.com/getodk/central-frontend/tree/master/apps/forms/CHANGELOG.md#<version-without-dots>)
* [packages/web-forms](https://github.com/getodk/central-frontend/blob/master/packages/web-forms/CHANGELOG.md#<version-without-dots>)
* [packages/xforms-engine](https://github.com/getodk/central-frontend/blob/master/packages/xforms-engine/CHANGELOG.md#<version-without-dots>)
* [packages/xpath](https://github.com/getodk/central-frontend/tree/master/packages/xpath/CHANGELOG.md#<version-without-dots>)

@garethbowen garethbowen Sep 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like the human readable nature of the rest of the items, which made me think these frontend items are very confusing unless you know the internal structure of the repo.

But then I tried naming them and realised they're just conceptually difficult.

What do you think about rolling the changelogs up into either one (frontend) or two (central frontend and web forms)? This could either be done by manually selecting apps/forms every time we generate a changeset for web-forms packages, OR in a script somehow. People who use the individual packages as libraries will still have the individual changelog as well, but the combined release notes will be simpler.

@matthew-white matthew-white Sep 16, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I tried naming them and realised they're just conceptually difficult.

That makes a lot of sense to me. 👍 Especially the seams between the different packages/apps. Rather than trying to get the user to understand those, I like the idea of just telling them what they need to do / what they need to look at. I added a note along those lines to try to make it clear that currently they need to look at multiple changelogs (in d477d56).

What do you think about rolling the changelogs up into either one (frontend) or two (central frontend and web forms)?

Rolling them up sounds nice in terms of the experience of users looking at changelogs. I'm a little wary of creating extra work for ourselves though. Most users won't be looking at the detailed changelogs. I think it's OK if they have to click into a few different changelogs.

If we were to roll them up, I don't have a strong preference between one or two. I can kind of see it both ways.

This could either be done by manually selecting apps/forms every time we generate a changeset for web-forms packages

If you all want to start doing that, I certainly don't have an objection. Practically speaking though, since it'd be done manually, I feel like omissions would be possible.

OR in a script somehow.

That's an interesting idea. We already run npm run version as part of the release. We could run a script right after that, or run a script that runs npm run version + does the additional changelog merging/combining. Would you be interested in writing that script? It's probably not something I'd get to right away.

In terms of next steps, maybe we could try to get this PR merged first, then file a follow-up issue about a script?

* [API](https://docs.getodk.org/central-api-changelog/)
* [Operations infrastructure](https://github.com/getodk/central/blob/master/CHANGELOG.md#<version-without-dots>)
```

Expand Down
Loading