Skip to content

chore: move changelog to CC-Book release notes#2181

Open
fewerner wants to merge 8 commits into
mainfrom
felix/release-notes
Open

chore: move changelog to CC-Book release notes#2181
fewerner wants to merge 8 commits into
mainfrom
felix/release-notes

Conversation

@fewerner
Copy link
Copy Markdown
Contributor

What's new in this PR

This PR moves the relevant sections of our changelog to a new release notes section in the CC-Book.
It removes CHANGELOG.md.


PR Submission Checklist for internal contributors
  • The PR Title
    • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
    • contains a reference JIRA issue number like SQPIT-764
    • answers the question: If merged, this PR will: ... ³
  1. https://sparkbox.com/foundry/semantic_commit_messages
  2. https://github.com/wireapp/.github#usage
  3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

fewerner added 5 commits May 28, 2026 11:02
We can just start every release note with the release highlights. No
nead for a heading
We add headings per major version to make the toc more readible and not
show any subsections of releases.
@fewerner fewerner changed the title chore: move Changelog.md to CC-Book release notes chore: move changelog to CC-Book release notes May 28, 2026
@fewerner fewerner force-pushed the felix/release-notes branch from d3bfb7d to 6a45e68 Compare May 28, 2026 13:29
fewerner added 2 commits May 28, 2026 15:30
We no longer maintain a changelog. Instead we have handwritten release
notes and migration guides.
@fewerner fewerner force-pushed the felix/release-notes branch from 6a45e68 to 38d6728 Compare May 28, 2026 13:30
We want to test the implementation of this action before merging it.
Github only allows us to run an action from a PR if the file exists on
the default branch. Therefore, this action will be implemented in a
separate PR.
@fewerner fewerner force-pushed the felix/release-notes branch from 38d6728 to 6c01674 Compare May 28, 2026 13:35
@fewerner fewerner marked this pull request as ready for review May 28, 2026 14:12
@fewerner fewerner requested a review from a team May 28, 2026 14:12
Copy link
Copy Markdown
Contributor

@coriolinus coriolinus left a comment

Choose a reason for hiding this comment

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

This seems good, but incomplete. There are two major things I'd like to see:

  1. Eliminate all release notes which are just links to commits. We have tons of instances of

    ### Bug Fixes    
    
    - no more errors when deleting non-existent credential
      ([aa0195c](https://github.com/wireapp/core-crypto/commit/fbe5735e55fd61ec4544795f6dfe6208a27c73be))

    and similar, and none of them make for good reading. If we're doing this in book format, we should do it right.

  2. Deduplicate the CC 10 section of the release notes. We have a whole CC 10 section of the book with migration what's new and migration guide; all that content should be excised from the CC 10 release notes. The highlight for CC 10 is effectively "new E2EI and related APIs".

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.

2 participants