-
-
Notifications
You must be signed in to change notification settings - Fork 212
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
Automate release process #325
Conversation
For PyPI releases of this project, I told @ekcorso I was trying to remember and manually execute several steps. We collaborated on this script offline. Now my manual steps are codified in this repo! Hopefully less error prone for me, and the steps could be followed by any maintainer. I'm excited to put this to use. Thank you! |
Prerequisites: | ||
- This must be run from the root of the repository. | ||
- The repo must have a clean git working tree. | ||
- The user must have the GITHUB_TOKEN environment variable set to a valid GitHub personal access token. |
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.
Can you add a bullet for PyPI credentials? During the script, users will need to paste in a token from their password manager?
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.
No problem. Done!
I used the script to release 5.1.2. Script worked like a charm! 🙌 Only a couple minor follow-ups:
|
This automates the process for releasing a new version of tldextract. It prompts the user to add a tag, creates a build, prompts for verification, uploads the build to PyPi, pushes the new tag to Github, and then creates a draft of the Github release.
Note that the release notes will be based based on a combination of the CHANGELOG.md entry that matches the version tag and GitHub's generated changelog URL.
The user will need a Github app auth token and Pypi credentials in order to run this.
Changes
--explicit-package-bases