Skip to content
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

Jump to bottom

Consider publishing a pre-made Markdown checklist alongside changelog #1682

Open
turt2live opened this issue Nov 29, 2023 · 3 comments · May be fixed by #1937
Open

Consider publishing a pre-made Markdown checklist alongside changelog #1682

turt2live opened this issue Nov 29, 2023 · 3 comments · May be fixed by #1937
Labels
improvement An idea/future MSC for the spec meta Something that is not a spec change/request and is not related to the build tools

Comments

@turt2live
Copy link
Member

Several projects use our changelog and add checkboxes in front of each item to track their support for that release. We can probably make this easier with a https://spec.matrix.org/v1.9/checklist.md sort of thing.

Examples:

I'd suggest we go with doing something similar to Ruma's template - individual projects can edit the template further if they choose (like how Synapse does it).
@turt2live turt2live added meta Something that is not a spec change/request and is not related to the build tools improvement An idea/future MSC for the spec labels Nov 29, 2023
@clokep
Copy link
Member

clokep commented Nov 29, 2023

FWIW I'd be fine with the synapse one having extra checkboxes to check off. I usually just remove the clarifications, but I'm a fan of checking things off. 😀 I think Dendrite usually copies the Synapse ones too.

Johennes added a commit to Johennes/matrix-spec that referenced this issue Aug 21, 2024
@Johennes
Output changelog checklists
efede88 
Fixes: matrix-org#1682
Signed-off-by: Johannes Marbach <[email protected]>
@Johennes Johennes mentioned this issue Aug 21, 2024
Closed
3 tasks
@Johennes
Copy link
Contributor

Johennes commented Aug 21, 2024 •
edited
Loading

I've tried making a rough PoC for this with checklists in a separate section and pages under /checklists/$version/index.md in #1936. It's sort of crappy though and I would welcome input if anyone has some.

Johennes added a commit to Johennes/matrix-spec that referenced this issue Aug 22, 2024
@Johennes
Output changelog checklists
4250f33 
Fixes: matrix-org#1682
Signed-off-by: Johannes Marbach <[email protected]>
@Johennes Johennes linked a pull request Aug 22, 2024 that will close this issue
Open
3 tasks
@Johennes
Copy link
Contributor

Johennes commented Aug 22, 2024 •
edited
Loading

#1937 is a variant that turns the changelog page itself into a section and outputs checklists under /changelog/$VERSION/checklist.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
improvement An idea/future MSC for the spec meta Something that is not a spec change/request and is not related to the build tools
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Provide MD checklists for the changelog Johennes/matrix-spec
3 participants
@clokep @Johennes @turt2live