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

Remove details-summary construct from changelog template #55

Closed
redeboer opened this issue Apr 7, 2022 · 1 comment
Closed

Remove details-summary construct from changelog template #55

redeboer opened this issue Apr 7, 2022 · 1 comment
Assignees
Labels
🖱️ DX Improvements to the Developer Experience

Comments

@redeboer
Copy link
Member

redeboer commented Apr 7, 2022

Currently, the release drafter summarises all pull requests with details-summary syntax. This looks fancy, but results in duplicate information: one could just click the PR link for more info. In addition:

  • The info under the folded details not searchable (which was the main intend).
  • There is duplicate info (no SSoT). It would be better to just update the details in the description of each listed PR, if there is any info.
  • Info under <summary> does not support Markdown

Another motivation: RTD recently started removing PR preview build files, which means that they cannot be used as permalinks anymore (which is often done as links to notebook previews in PR descriptions). One should instead switch to links to the specific version pages on RTD (e.g. ampform.readthedocs.io/en/0.14.0), which can only be done by updating the PR descriptions after the version has been released.

@redeboer redeboer added the 🖱️ DX Improvements to the Developer Experience label Apr 7, 2022
@redeboer redeboer self-assigned this Apr 7, 2022
@redeboer
Copy link
Member Author

redeboer commented Apr 9, 2022

Perhaps this can be complemented with:
https://github-activity.readthedocs.io/en/latest/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🖱️ DX Improvements to the Developer Experience
Projects
None yet
Development

No branches or pull requests

1 participant