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

Add a usage guide to packaging.python.org #2

Closed
webknjaz opened this issue Jun 23, 2019 · 7 comments · Fixed by pypa/packaging.python.org#647
Closed

Add a usage guide to packaging.python.org #2

webknjaz opened this issue Jun 23, 2019 · 7 comments · Fixed by pypa/packaging.python.org#647
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@webknjaz
Copy link
Member

webknjaz commented Jun 23, 2019

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

@webknjaz webknjaz added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jun 23, 2019
@sco1
Copy link

sco1 commented Sep 4, 2019

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 dist/ directory cannot be found.

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!

@webknjaz
Copy link
Member Author

Thanks for your feedback! This should probably go to README.

@hugovk
Copy link
Contributor

hugovk commented Sep 16, 2019

What happens if a repo is set up to publish, and I fork the repo, and push to my fork?

@webknjaz
Copy link
Member Author

I haven't tried that. But the fork won't see the secrets saved in the upstream repo.

@hugovk
Copy link
Contributor

hugovk commented Sep 16, 2019

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

@webknjaz
Copy link
Member Author

Yeah, maybe. I'll leave it out for now. That would be smth like if: github.repository == 'your/repo'. Ref: https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions#github-context

@pradyunsg pradyunsg removed the good first issue Good for newcomers label Sep 27, 2019
@webknjaz
Copy link
Member Author

The initial version of the guide has been published. I'll be addressing other concerns (like #15) as follow-up PRs later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants