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

Replace News document with an automated monthly changelog #1384

Open
willingc opened this issue Nov 13, 2023 · 6 comments
Open

Replace News document with an automated monthly changelog #1384

willingc opened this issue Nov 13, 2023 · 6 comments
Labels
type: task Something that needs to be done that is not a bug or feature

Comments

@willingc
Copy link
Contributor

Help give maintainers and readers information on what has been changed/added/removed in the Packaging Guide by creating a monthly sectioned changelog. This would be similar to the existing News Page. Ideally, we would automate this.

@willingc willingc added the type: task Something that needs to be done that is not a bug or feature label Nov 13, 2023
@willingc
Copy link
Contributor Author

Screenshot 2023-11-13 at 1 21 28 PM

@pradyunsg
Copy link
Member

pradyunsg commented Nov 13, 2023

I think the news section was meant to cover "what happened in Python packaging" but, evidently, we haven't been keeping up with that and reorienting this to focus on how has this website is evolving seems like a good idea.

I guess the main question here is: How do we want to do this?

Do we want curated entries, AKA https://github.com/twisted/towncrier style where someone explicitly writes the human-facing summary, or do we want to just use the commit history to provide this context as is common with the NodeJS community / GitHub's automated release notes thingie?

@chrysle
Copy link
Contributor

chrysle commented Nov 13, 2023

or do we want to just use the commit history to provide this context as is common with the NodeJS community / GitHub's automated release notes thingie?

I personally am more comfortable with the authors describing their work "human-readable" / in detail themselves.

@willingc
Copy link
Contributor Author

willingc commented Nov 14, 2023

Thanks for the context @pradyunsg. Perhaps 2 changes in 2 separate PRs:

  • Add the original News purpose as a note at the top of the news file
  • Automate a changelog (given the time/effort to make human readable, I would just pull the actual commits)

Alternatively, we could just clarify the News purpose with a note for now.

@jeanas
Copy link
Contributor

jeanas commented Nov 14, 2023

I personally am more comfortable with the authors describing their work "human-readable" / in detail themselves.

I'm not sure what exactly you mean by this, but I'd be wary of adding work to the contribution process.

@chrysle
Copy link
Contributor

chrysle commented Nov 14, 2023

I'm not sure what exactly you mean by this, but I'd be wary of adding work to the contribution process.

I mean newsfragments.

(given the time/effort to make human readable, I would just pull the actual commits)

I'd argue we don't always have a PR frequency like now.

github-merge-queue bot pushed a commit that referenced this issue Nov 14, 2023
Add note that News doc is not currently being updated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: task Something that needs to be done that is not a bug or feature
Projects
None yet
Development

No branches or pull requests

4 participants