pypa / pypa/setuptools

[Docs] Clarify setup.cfg-only Package Release Tagging

Open
#2,819 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Summary

Reading the current setuptools v58.2.0 documentation, it is unclear to me how to tag setup.cfg-only package releases. This page mentions that you can add tag settings to your setup.cfg file. However, this page does not mention this at all.

My specific goal in reading the documentation was to learn how to tag a setup.cfg-only package with a custom build tag, in the style of --tag-build=STRING.

OS / Environment

No response

Additional Information

This documentation change better helps developers move toward a setup.cfg-only setuptools future.

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 with the distribution page's “Making official (non-snapshot) releases” section and the declarative_config page, then compare how setup.cfg-only configuration is documented with the --tag-build=STRING goal. Done means the documentation clearly explains how to configure a custom build tag for a setup.cfg-only package release.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.