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

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

Open
1 task done
markgras opened this issue Oct 17, 2021 · 4 comments
Open
1 task done

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

markgras opened this issue Oct 17, 2021 · 4 comments

Comments

@markgras
Copy link

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
@markgras markgras added documentation Needs Triage Issues that need to be evaluated for severity and status. labels Oct 17, 2021
@abravalheri
Copy link
Contributor

abravalheri commented Jan 5, 2022

Hi @markgras, thank you very much for opening this issue.

Any chance this is related to #2491? (i.e. are you using python -m build?)

@markgras
Copy link
Author

markgras commented Jan 5, 2022

Not necessarily. This issue is that the documentation doesn't tell a user how to tag setup.cfg-only packages. If passing tags to python -m build is supposed to work and is the intended way that users are to tag setup.cfg-only packages, then #2491 is related. I did at one point try passing tags to python -m build and it didn't work, but it was unclear to me if I was supposed to be doing that.

@abravalheri
Copy link
Contributor

Thank you very much for the clarification @markgras!
Yes, indeed this topic needs better docs, however it is likely that it will take a bit longer because there are some discussions going on.

Meanwhile, if you are using build, there is a hint on how this can be done in pypa/build#202 (comment), but I suspect you can also try borrowing a bit of setuptools' own configuration:

setuptools/setup.cfg

Lines 138 to 140 in 6092cdc

[egg_info]
tag_build = .post
tag_date = 1

This is a distutils configuration, but there might be some dragons.

@abravalheri abravalheri added help wanted and removed Needs Triage Issues that need to be evaluated for severity and status. labels Jan 5, 2022
@markgras
Copy link
Author

markgras commented Jan 5, 2022

Understood. Thank you for sharing these workarounds.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants