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

Generate changelogs from fragements #829

Open
joshmoore opened this issue Sep 9, 2021 · 12 comments · May be fixed by #2736
Open

Generate changelogs from fragements #829

joshmoore opened this issue Sep 9, 2021 · 12 comments · May be fixed by #2736
Labels
documentation Improvements to the documentation

Comments

@joshmoore
Copy link
Member

e.g. https://github.com/ansible-community/antsibull-changelog/blob/main/docs/other-projects.rst

At the moment, PRs regularly conflict due to conflicts to release.rst. By moving to a fragment based system, this should go away.

Any other recommendations for frameworks?

@grlee77
Copy link
Contributor

grlee77 commented Sep 10, 2021

Towncrier is used by NumPy and we are considering it for scikit-image

@joshmoore
Copy link
Member Author

Had looked at that one previously as well. 👍 All the better if your experiences have been good.

@grlee77
Copy link
Contributor

grlee77 commented Sep 10, 2021

We have a draft PR and were planning to start using it in the near future, so I don't have much experience with it yet. I was not aware of the ansible one you linked above, but it sounds like something similar.

Another approach that SciPy has used in the past is having contributors update a wiki page that the release manager can then pull from when making the release notes. I'm not sure how consistently it is applied, though.

Towncrier or antsibull will solve the conflicts problem, but there is still the separate problem of prompting contributors to create the fragments needed!

@joshmoore
Copy link
Member Author

I'd hope it'd be easy enough to add an action that says, "must have fragment". Worst case: we can push it to the PRs manually. 😉

@joshmoore
Copy link
Member Author

Another possible option: https://sphinx-github-changelog.readthedocs.io/en/latest/ (...as I struggle with the anchors for pre-releases ...)

cc: @MSanKeys963

@joshmoore
Copy link
Member Author

joshmoore commented May 26, 2022

But generally, 👍 for:

  • keeping it simple
  • having a check on all PRs
  • ability to break the current formatting & move to something new (e.g. with zarr-python 3.x)

@jakirkham
Copy link
Member

We've used rever in conda-smithy

@jakirkham
Copy link
Member

Josh mentioned this changelog proposal.

@jakirkham
Copy link
Member

Another option somewhat similar to towncrier is scriv

@joshmoore
Copy link
Member Author

@MSanKeys963: this is something to review before we (potentially) launch the outreachy project.

@sanketverma1704
Copy link
Member

Sure. Adding to the list.
We can let the Outreachy intern experiment with multiple tools before we finalise a single one for Zarr.

@jakirkham
Copy link
Member

+1 though it would be good to make sure that those experimenting get credit for that (even if it doesn't wind up merged). The experimenting is itself a useful step 🙂

@dstansby dstansby added the documentation Improvements to the documentation label Dec 28, 2024
@dstansby dstansby linked a pull request Jan 20, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation
Projects
None yet
5 participants