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

Create release notes for v4.7.0 using towncrier #918

Merged
merged 4 commits into from
Apr 20, 2023

Conversation

umarcor
Copy link
Member

@umarcor umarcor commented Mar 8, 2023

This is not to be merge yet!

This PR is related to #885.

In preparation for releasing v4.7.0, I run two queries in GitHub's GraphQL Explorer and I saved the results in two JSON files. Then, I wrote a Python script that takes those JSON files and generates a markdown file for each issue|pr or commit. I run the script and added all the files to the PR. Note that:

  • "issues" are issues or PRs which are milestoned.
  • "commits" are the last 100 commits in branch master. Hence, there are 17 commits missing (the first after tag v4.6.0).

Yet to be done:

/cc @GlenNicholls

@umarcor umarcor force-pushed the umarcor/change-files branch 2 times, most recently from 234152f to 90fda0f Compare March 11, 2023 05:13
@eine eine added this to the v4.7.0 milestone Mar 11, 2023
@umarcor umarcor force-pushed the umarcor/change-files branch 3 times, most recently from 1721b52 to 4bbbbf2 Compare March 12, 2023 04:28
@umarcor
Copy link
Member Author

umarcor commented Mar 12, 2023

This PR is now based on #921. I went through the ~200 issues|PRs|commits and I created ~75 news fragments.

I changed the categories/types to add doc and feature, and I removed change.

I found some limitations in towncrier:

  • It's not possible to assign multiple PRs|issues to a single fragment. In order to get multiple refs in one item, the fragment file needs to be duplicated with different filenames. The content must be exactly the same (including line-endings). I think the duplication is acceptable until they improve it in towncrier.
  • It's possible to have fragments with commit refs, instead of PRs|issues. For instance, g758b9e47.deprecation.rst. However, it's not possible to have them linked. This is because configuration option issue_format supports a simple replacement of variable {issue}; it does not support complex logic to select the format depending on the ID/prefix. Therefore, I decided to use +758b9e47.deprecation.rst, which shows those items without any ID/ref.
  • Since the template or the issue_format cannot be overriden in CLI, it's not straightforward to support two outputs (one for GitHub Releases without sphinx features, and another one to be included in sphinx). Even if we used markdown only, we would still need to maintain two configuration files. Therefore, I propose to stop adding release notes to the GitHub Releases, and instead just add a link to the corresponding section in the docs. This PR adds labels before each subsection so we can use https://vunit.github.io/release_notes.html#release-4-6-0.

@LarsAsplund @GlenNicholls if you are good with the implementation in #921 and the news fragments introduced in this PR, we can introduce towncrier already and use it to handle the remaining PRs before releasing v4.7.0. Actually, we can merge #921 and #918 and keep changing the fragments until we decide to release v4.7.0.

@umarcor umarcor force-pushed the umarcor/change-files branch 2 times, most recently from 23f098c to 0e47f45 Compare April 20, 2023 00:50
@umarcor umarcor marked this pull request as ready for review April 20, 2023 01:16
@eine eine merged commit d181cd3 into VUnit:master Apr 20, 2023
@umarcor umarcor deleted the umarcor/change-files branch April 20, 2023 01:22
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

2 participants