Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Update changelog to describe changes from #12370 relative to develop #12401

Merged
merged 2 commits into from
Apr 6, 2022

Conversation

MadLittleMods
Copy link
Contributor

@MadLittleMods MadLittleMods commented Apr 6, 2022

Update changelog to describe changes from #12370 relative to develop

Follow-up to #12370

Context: #12370 (comment)

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Pull request includes a sign off
  • Code style is correct
    (run the linters)

@MadLittleMods MadLittleMods requested a review from a team as a code owner April 6, 2022 17:36
@MadLittleMods MadLittleMods added the T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks. label Apr 6, 2022
@@ -1 +1 @@
Fix `/messages` returning backfilled and [MSC2716](https://github.com/matrix-org/synapse/pull/12319) historic messages our of order.
Update `/messages` to use historic pagination tokens by default.
Copy link
Contributor Author

@MadLittleMods MadLittleMods Apr 6, 2022

Choose a reason for hiding this comment

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

Previously, the changelog was describing changes relative to #12319 which fixes a bug on top of those changes.

But #12370 is a good fix in itself and is being merged independently of #12319. So what #12370 actually changes is just

Update /messages to use historic pagination tokens by default.

Copy link
Member

Choose a reason for hiding this comment

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

Does "by default" make sense or should it be "if no from parameter is given" or something?

"Update" sounds a bit like a behavior change FWIW, not a bugfix.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@clokep Updated with .feature and your language around being explicit with whether from is provided. I think "by default" also made sense 🤷

@clokep
Copy link
Member

clokep commented Apr 6, 2022

(This is going to fail CI checks, but we can override those.)

@MadLittleMods MadLittleMods requested a review from clokep April 6, 2022 18:20
@clokep clokep merged commit f931c06 into develop Apr 6, 2022
@clokep clokep deleted the madlittlemods/update-12370-changelog branch April 6, 2022 18:41
@MadLittleMods
Copy link
Contributor Author

Thanks for the review and merge @clokep 🐸

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants