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
Add a usage guide to packaging.python.org #2
Comments
Had some time to play around with this last night after stumbling across the Discource conversation that led to this package and have a couple minor points of clarity to raise for a more generic usage guide: as someone with essentially no experience with GH Actions, I think it could be clearer that this action is dependent on an explicit build step in the workflow or it's going to fail out because the Once I figured this out I had no issues getting this going on https://test.pypi.org/, can't wait to get it into production! |
Thanks for your feedback! This should probably go to README. |
What happens if a repo is set up to publish, and I fork the repo, and push to my fork? |
I haven't tried that. But the fork won't see the secrets saved in the upstream repo. |
Yes, that's good. Would be interesting to test it out at some point, it'd be good to avoid failing any builds for forks. Perhaps a guard similar to this with Travis would be needed: https://github.com/hugovk/pypistats/blob/7982c5cebb06f1ff7883e596a66a598b3f373691/.travis.yml#L32 |
Yeah, maybe. I'll leave it out for now. That would be smth like |
The initial version of the guide has been published. I'll be addressing other concerns (like #15) as follow-up PRs later. |
I think it should be in a how-to tutorial style.
All info (more or less) is already in the README. It just needs to be turned into a nice and detailed text.
Essentially, this action just runs
twine upload
meaning that anything that twine can do can be done with an Action.We need to explain that users can easily set any env vars twine consumes and how to be careful with secrets.
Start here: https://github.com/pypa/packaging.python.org/fork
The text was updated successfully, but these errors were encountered: