-
Notifications
You must be signed in to change notification settings - Fork 3
feat: release from tags instead of branch promotion #446
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
base: main
Are you sure you want to change the base?
Conversation
* Removes release_prod.yaml and prod_patches_to_main.yaml workflows as they are no longer needed. * pypy.yaml workflow now triggers on semver tags instead of prod branch pushes. * new create_release_tag.yaml workflow will handle tag creation New release process: 1. Update version in pyproject.toml 2. Commit and merge to main 3. Trigger "Create Release Tag" workflow with the version number 4. Tag creation automatically triggers pypi deployment We can switch to tag creation on pyproject.toml version updates if we want, I just thought still having a human in the loop on when to push might be an easier transition. Signed-off-by: Cullen Taylor <cullen@eggshell.me>
PR SummaryThis PR introduces several changes to the project's GitHub Actions workflows. The most significant change is the addition of a new workflow (create_release_tag.yaml) that automates the creation of release tags. This workflow allows a user to manually trigger it by providing a version number. It checks out the main branch, installs Poetry via pipx, and uses a version check against the pyproject.toml file to ensure the version provided matches the current project version. If the versions match, it creates and pushes a Git tag followed by the creation of a corresponding GitHub release. In addition, the PR removes two older workflows (prod_patches_to_main.yaml and release_prod.yaml) that handled merging prod hotfixes into main and creating prod releases, respectively. This streamlining suggests a move towards a simplified release and deployment process. Finally, the PyPI deployment workflow (pypi.yaml) has been updated to trigger on tag pushes following a semantic versioning pattern (v*..) rather than on pushes to the prod branch. This adjustment aligns the deployment process with the new tagging strategy and ensures that releases are only published when a properly formatted tag is created. Test Suggestions
|
|
Question: is it better to use githubs ui for creating a gh release? |
|
@nibalizer tbh what you usually end up doing in the UI is just hitting the |
johnwalz97
left a comment
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.
thank you!!
Pull Request Description
What and why?
Removes release_prod.yaml and prod_patches_to_main.yaml workflows as they are no longer needed.
pypy.yaml workflow now triggers on semver tags instead of prod branch pushes.
new create_release_tag.yaml workflow will handle tag creation
New release process:
We can switch to tag creation on pyproject.toml version updates if we want, I just thought still having a human in the loop on when to push might be an easier transition.
How to test
What needs special review?
Dependencies, breaking changes, and deployment notes
Release notes
Checklist