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.

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

Recreate changelog as markdown #1281

Merged
merged 3 commits into from Jun 6, 2023
Merged

Recreate changelog as markdown #1281

merged 3 commits into from Jun 6, 2023

Conversation

yuvipanda
Copy link
Collaborator

github-activity, used for other JupyterHub release processes, now outputs markdown. This PR moves the existing changelog to use markdown, and provides a more complete list of changes too.

Ref #1280

github-activity, used for other JupyterHub release processes,
now outputs markdown. This PR moves the existing changelog
to use markdown, and provides a more complete list of
changes too.

Ref jupyterhub#1280
@yuvipanda yuvipanda requested review from minrk and manics June 5, 2023 19:59
@minrk
Copy link
Member

minrk commented Jun 6, 2023

Looks like most of the PR classification was lost in the regenerated changelog because I'm guessing they were grouped by hand instead of labeled. Maybe rst2myst would give a better starting point?

@manics
Copy link
Member

manics commented Jun 6, 2023

This is what I use for converting the output of github-activity to RST:

github-activity --target jupyterhub/repo2docker --since 2022.02.0  | sed -r \
  -e 's%\[#([0-9]+)\]\(https://github.com/jupyterhub/repo2docker/pull/[0-9]+\)%:pr:`\1`%' \
  -e 's%\(\[\@([A-Za-z0-9-]+)\]\(https://github.com/[A-Za-z0-9-]+\)\)%by :user:`\1`%'

Perhaps you can try reversing the sed commands?

@minrk
Copy link
Member

minrk commented Jun 6, 2023

I don't even think we need to do that - the directives still exist and work, and rst2myst handles the syntax translation correctly.

@consideRatio
Copy link
Member

Thanks for working this @yuvipanda!!! I recall thinking I'd help drive the release effort in this repo once only to run into the "oh no... its a .rst changelog" and loosing momentum to get it done.

I'd rather retain the changelog as it but with syntax conversion than to re-generate it and adopt github-activity going onwards, but I figure its also okay to re-generate things but I'd appreciate being able to overview changes to the changelogs content if that is done.

I figure if a changelog is regenerated, we can have changes based on:

  • PRs that was categorized manually rather than based on the labels
  • PRs that was omitted because they were automated things that we perceived as too noisy, perhaps like weekly pre-commit updates

Btw for reference I wrote some notes on how I go about generating changelogs using github-activity in jupyterhub/team-compass#563, it includes the procedure of generating a changelog and then going to the PRs not labelled to label then, and then re-generating the changelog etc to get them categorized.

no content change, only syntax
@minrk
Copy link
Member

minrk commented Jun 6, 2023

I pushed the rst2myst changelog.md here, which should be the simplest change and produce the same HTML. No manual edits.

@yuvipanda yuvipanda merged commit 6d3b80c into jupyterhub:main Jun 6, 2023
2 checks passed
@yuvipanda
Copy link
Collaborator Author

Yay, thank you @minrk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants