pypa / pypa/setuptools

[Docs] Include changes in Github release body

Open
#2,807 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Summary

Not entirely sure if it's possible with the automated release workflow.

It would be nice if the version changes could be listed in the Github release body. Github offers the option to subscribe just to releases. With that it would be easier to see the changes directly.

OS / Environment

No response

Additional Information

An alternative would be to include a link to CHANGES.rst.

Code of Conduct
  • I agree to follow the PSF Code of Conduct

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the automated release workflow and reviewing CHANGES.rst. Determine whether the workflow can include version changes in the GitHub release body or provide a link to that file; done means newly generated releases expose the changes directly or link to them.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.