-
Notifications
You must be signed in to change notification settings - Fork 12
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
Fix: update release workflow to follow pypa and pypi guidelines #73
base: main
Are you sure you want to change the base?
Conversation
@@ -44,6 +44,22 @@ To use this template: | |||
as your source. You can read more about generating your project | |||
in the [copier documentation](https://copier.readthedocs.io/en/stable/generating/). | |||
|
|||
## How to run the test suite locally |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Friends, bare with me on the instructions. I'm still getting to know copier and am wrapping my head around the test suite works. it seems great as it caught some spacing issues in my workflow! I just don't fully understand it yet so if any of this isn't quite right please say the word!
i'd love review on this (but also see a merge conflict now that i just merged the other pr!! a few points of potential contention
id love your feedback here all @sneakers-the-rat @blink1073 @Midnighter i'd llike to get our template nailed down for spring workshops and then scipy if we get accepted! |
environment: | ||
name: pypi | ||
# Modify the url to be the name of your package | ||
url: https://pypi.org/p/yourPackage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should be able to template this line, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you are right! I forgot about that. I still need to learn more about how this works with copier. i'll update the PR this week.
environment: | ||
name: pypi | ||
# Modify the url to be the name of your package | ||
url: https://pypi.org/p/yourPackage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
url: https://pypi.org/p/yourPackage | |
url: https://pypi.org/p/${{ github.ref_name }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually it might be as simple as this. i'll test locally 🚀
this closes #48 We've been working with the pypa and pypi security folks on our blog post and this pr should address the suggested approaches to publishing using a release based workflow.
Because we are using a release, this assumes that tests are running on the main branch before a release is made. It also allows a dynamic maintainer team to make releases without the command line which is really nice.
NOTE: i haven't yet tested this specific file for issues. i'm not quite sure how - maybe via test pypi?