Skip to content

chore: write the whole changelog in the standard format - #273

Merged
oleksandr-nc merged 1 commit into
mainfrom
chore/changelog-format
Oct 23, 2026
Merged

oleksandr-nc merged 1 commit into
mainfrom
chore/changelog-format

Conversation

@oleksandr-nc

@oleksandr-nc oleksandr-nc commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Every version of CHANGELOG.md has the standard layout

The file had collected several layouts since 2020: version headings with an en dash, no blank line after most headings, lowercase entries and full stops, * bullets, pull request and issue links with author mentions, entries wrapped onto a second line, a plain "Maintenance update" line, and sections out of order in 2.0.7 and 3.2.7. All 49 versions now have the layout of integration_youtube's changelog: ## X.Y.Z - YYYY-MM-DD headings, a blank line after each heading, sections in the order Added, Changed, Removed, Fixed, Security, one sentence-case line per entry without pull request links, authors or trailing periods, and dependency updates as "Update dependencies" (with "& translations" where the entry named them) at the end of Changed. The security updates of 3.2.7 and 3.3.0 keep their own lines, 0.0.3's dependency line names the two packages it updated, @nextcloud/vue and @nextcloud/vue-dashboard, dates stay as written, and tags without a section are not added.

The Nextcloud versions follow appinfo/info.xml at each version's tag

Support for Nextcloud 35 moves from 3.2.7 to 3.2.5, whose tag raised the maximum to 35. Versions gained or dropped that no entry mentioned are added: 23 in 1.0.1, 24 in 1.0.4, 26 in 1.0.6, 27 in 2.0.1, 28 in 2.0.5, 31 in 3.0.0 and 32 in 3.2.0, and the drops in 1.0.5, 2.0.0, 3.1.0, 3.2.0, 3.2.2 and 3.2.3. Three lines now name the versions they meant: 0.0.18 gained Nextcloud 22, the minimum of 22 in 1.0.1 dropped 20 and 21, and the first release was for Nextcloud 20 and 21. The app declared no PHP version at any of these tags, so no Removed line names PHP.

🤖 AI (if applicable)

  • The content of this PR was partly or fully generated using AI

@oleksandr-nc
oleksandr-nc force-pushed the chore/changelog-format branch 2 times, most recently from 73d1f5f to 791e0d1 Compare October 23, 2026 15:23
The changelog mixed several layouts: version headings with an en dash,
no blank line after most headings, lowercase entries and full stops, `*`
bullets, pull request and issue links and author mentions, some links on
a line of their own, entries wrapped onto a second line, a plain
"Maintenance update" line, a double blank line, and Added after Changed
in 2.0.7 and Changed after Fixed in 3.2.7.

CHANGELOG.md now has the layout of integration_youtube's changelog in
every version: `## X.Y.Z - YYYY-MM-DD` headings, a blank line after each
heading and one between versions, sections in the order Added, Changed,
Removed, Fixed, Security, one line per entry in sentence case without
pull request links, authors or trailing periods, the Nextcloud versions
the app gained as "Added support for Nextcloud N" under Added and those
it dropped under Removed, and dependency updates as "Update
dependencies" (with "& translations" where the entry named them) at the
end of Changed. The security updates of 3.2.7 and 3.3.0 keep their own
lines, and 0.0.3's names the two packages it updated, @nextcloud/vue and
@nextcloud/vue-dashboard. Dates stay as written, and tags without a
section are not added.

The Nextcloud versions follow appinfo/info.xml at each version's tag.
Support for Nextcloud 35 is listed under 3.2.5, whose tag raised the
maximum to 35, instead of 3.2.7, whose range was that of 3.2.6. No entry
said that 1.0.1 added 23, 1.0.4 added 24 (1.0.2 raised the maximum to 24
but has no section), 1.0.6 added 26, 2.0.1 added 27, 2.0.5 added 28,
3.0.0 added 31 as well as 30, and 3.2.0 added 32, or that 1.0.5 dropped
22 to 24, 2.0.0 dropped 25, 3.1.0 dropped 26, 3.2.0 dropped 27 and 28,
3.2.2 dropped 29 to 31 and 3.2.3 dropped 32; those lines are added, the
ones for 24 in 1.0.4 and 31 in 3.0.0 folded into those versions' own
support lines. Three lines now name the versions they meant: 0.0.18
raised the maximum to 22, the minimum of 22 in 1.0.1 dropped 20 and 21,
and the first release was for Nextcloud 20 and 21. The app declared no
PHP version at any of these tags, so no Removed line names PHP.

Two vague lines say what changed: besides the two features that have
their own entries, the pull request behind 3.2.0 lists a package update,
and 0.0.20 was a republish to use the new app certificate. The node
package update of 2.0.7, by its own words "mainly vue 8", which was
@nextcloud/vue 8, gets a line for that move next to "Update
dependencies".

Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
@oleksandr-nc
oleksandr-nc force-pushed the chore/changelog-format branch from 791e0d1 to c46e2a4 Compare October 23, 2026 15:31
@oleksandr-nc
oleksandr-nc merged commit 1a6432b into main Oct 23, 2026
33 checks passed
@oleksandr-nc
oleksandr-nc deleted the chore/changelog-format branch October 23, 2026 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant