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

Emphasize permitted version format in packages for publication #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

OlenaYefymenko
Copy link
Owner

@OlenaYefymenko OlenaYefymenko commented May 1, 2023

The patch adds mention in README that local version identifiers in packages don’t allow publishing to PyPI/TestPyPI. Also, it suggests alternative local servers for using local version identifiers.

Resolves pypa#322

@OlenaYefymenko OlenaYefymenko force-pushed the 322-doc-version-format-for-publication branch from 1bc675a to 76d1a13 Compare May 7, 2023 14:27
@OlenaYefymenko OlenaYefymenko changed the title Emphasize permitted version format for publication Emphasize permitted version format in packages for publication May 7, 2023
@OlenaYefymenko
Copy link
Owner Author

@webknjaz, could you please review the updated PR and provide your feedback?

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@OlenaYefymenko OlenaYefymenko force-pushed the 322-doc-version-format-for-publication branch from db66bb6 to 3eb3ce3 Compare May 28, 2023 16:02
@OlenaYefymenko OlenaYefymenko deleted the 322-doc-version-format-for-publication branch May 28, 2023 16:32
@OlenaYefymenko OlenaYefymenko restored the 322-doc-version-format-for-publication branch May 28, 2023 20:02
@OlenaYefymenko OlenaYefymenko force-pushed the 322-doc-version-format-for-publication branch from 23ae525 to dc4879c Compare May 29, 2023 11:50
README.rst Outdated
package indexes like PyPI or TestPyPI. The disallowed version segments may
be seen in auto-publishing workflows or when a configuration mistake is made.

However, if you need to use local version identifiers in your packages, you
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we shouldn't suggest people to use devpi just for the local version. This motivation is probably wrong. Instead, mention that some indexes, like devpi, allow those.

@OlenaYefymenko OlenaYefymenko force-pushed the 322-doc-version-format-for-publication branch from dc4879c to 6f3bfa6 Compare May 29, 2023 17:59
The patch adds mention in README that local version identifiers in packages
don't allow publishing to PyPI/TestPyPI. Also, it suggests alternative local
servers for using local version identifiers.

Resolves pypa#322

Co-authored-by: Sviatoslav Sydorenko <webknjaz+github/profile@redhat.com>
@OlenaYefymenko OlenaYefymenko force-pushed the 322-doc-version-format-for-publication branch from 6f3bfa6 to b6c0412 Compare May 29, 2023 18:58
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README should mention that PyPI doesn't accept local version identifiers
2 participants