Skip to content

website: Add the CHANGELOG #6748

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.

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
merged 1 commit into from
Jul 17, 2025
Merged

website: Add the CHANGELOG #6748

merged 1 commit into from
Jul 17, 2025

Conversation

PhilipMetzger
Copy link
Contributor

This was requested by @lilyball on Discord. I still think we should create a blog longterm so we can announce stuff and run surveys, but this small step won't block it.

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • I have updated the config schema (cli/src/config-schema.json)
  • I have added/updated tests to cover my changes

@PhilipMetzger PhilipMetzger requested a review from a team as a code owner June 12, 2025 13:52
@PhilipMetzger PhilipMetzger force-pushed the pm/push-llsslmylzqwm branch 2 times, most recently from e885943 to e8ba450 Compare June 12, 2025 14:05
@PhilipMetzger PhilipMetzger marked this pull request as draft June 12, 2025 14:58
@PhilipMetzger
Copy link
Contributor Author

@ilyagr Do you have any suggestions how I can preserve the current CHANGELOG.md without needing to adjust all current links, since it fails the link-strict check of mkdocs?

@ilyagr
Copy link
Contributor

ilyagr commented Jun 26, 2025

I'm not sure whether it will work or is a good idea, but you could try using https://github.com/mondeja/mkdocs-include-markdown-plugin (which we are already using for the CLI reference) with rewrite_relative_urls: true.

@ilyagr
Copy link
Contributor

ilyagr commented Jun 26, 2025

I double-checked, and the docs/... links seem to magically work when copy-pasted into the release notes, e.g. https://github.com/jj-vcs/jj/releases/tag/v0.29.0. So, we probably don't want to change the links inside CHANGELOG.md itself. (Context: I briefly considered whether moving it to docs/ would be reasonable, but it seems not).

@PhilipMetzger
Copy link
Contributor Author

So, we probably don't want to change the links inside CHANGELOG.md itself. (Context: I briefly considered whether moving it to docs/ would be reasonable, but it seems not).

Yes, I already had thrown the option of moving the file out of the window 😄 since it's important to preserve the top-level CHANGELOG as is.

I'm not sure whether it will work or is a good idea, but you could try using https://github.com/mondeja/mkdocs-include-markdown-plugin (which we are already using for the CLI reference) with rewrite_relative_urls: true.

Thanks for this suggestion, it'll hopefully work just like the CLI reference.

@PhilipMetzger PhilipMetzger force-pushed the pm/push-llsslmylzqwm branch 2 times, most recently from 94298b2 to 6576475 Compare June 27, 2025 15:41
@PhilipMetzger PhilipMetzger force-pushed the pm/push-llsslmylzqwm branch from 6576475 to a484118 Compare June 27, 2025 18:26
@PhilipMetzger PhilipMetzger force-pushed the pm/push-llsslmylzqwm branch 3 times, most recently from c8ca7ad to 6cd4944 Compare July 9, 2025 16:14
@PhilipMetzger PhilipMetzger force-pushed the pm/push-llsslmylzqwm branch from 6cd4944 to c8c37bc Compare July 17, 2025 21:01
@PhilipMetzger PhilipMetzger marked this pull request as ready for review July 17, 2025 21:03
@PhilipMetzger
Copy link
Contributor Author

I've adjusted all the links now, @ilyagr care to review?

Copy link
Contributor

@ilyagr ilyagr left a comment

Choose a reason for hiding this comment

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

Seems to work well and look good, thank you very much!

One downside is that every released version will likely have a useless skeleton section for [Unreleased], as in 312c610. But this is not fatal, and we could fix it in another PR if we come up with an idea.

@PhilipMetzger PhilipMetzger force-pushed the pm/push-llsslmylzqwm branch from c8c37bc to c522bf5 Compare July 17, 2025 22:51
This was requested by @lilyball on Discord. I still think we should create a blog longterm
so we can announce stuff and run surveys, but this small step won't block it.
@PhilipMetzger PhilipMetzger force-pushed the pm/push-llsslmylzqwm branch from c522bf5 to 2d7a03f Compare July 17, 2025 22:54
@PhilipMetzger PhilipMetzger added this pull request to the merge queue Jul 17, 2025
Merged via the queue into main with commit 24e565c Jul 17, 2025
27 checks passed
@PhilipMetzger PhilipMetzger deleted the pm/push-llsslmylzqwm branch July 17, 2025 23:11
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