{"id":21287764,"url":"https://github.com/stjudecloud/release-python-action","last_synced_at":"2026-02-07T10:31:11.693Z","repository":{"id":115471805,"uuid":"429945667","full_name":"stjudecloud/release-python-action","owner":"stjudecloud","description":"Github Action to release a Poetry-based Python app as we regularly do on the St. Jude Cloud project.","archived":false,"fork":false,"pushed_at":"2022-08-30T01:52:30.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-22T05:04:40.941Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stjudecloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-19T22:02:33.000Z","updated_at":"2021-11-25T18:13:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"72ec7e5f-8e43-4f06-91f6-939f76882880","html_url":"https://github.com/stjudecloud/release-python-action","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/stjudecloud/release-python-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stjudecloud%2Frelease-python-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stjudecloud%2Frelease-python-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stjudecloud%2Frelease-python-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stjudecloud%2Frelease-python-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stjudecloud","download_url":"https://codeload.github.com/stjudecloud/release-python-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stjudecloud%2Frelease-python-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29192609,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T07:37:03.739Z","status":"ssl_error","status_checked_at":"2026-02-07T07:37:03.029Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T12:15:40.146Z","updated_at":"2026-02-07T10:31:11.679Z","avatar_url":"https://github.com/stjudecloud.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Release Python Action\n\nThis Github Action provides a consistent action for building and releasing\nPython command line tools on the St. Jude Cloud project. It may also be used\ngenerally, provided your package conforms the following set of prerequisites:\n\n- [Poetry] is used for package management.\n- [Conventional commits] are used to describe changes to the project.\n\nThis action will always complete the following tasks, though we may change how\nit achieves them in future releases.\n\n- Automate releases to PyPI using conventional commits/semantic releases.\n    - Currently [python-semantic-release] is used to achieve this.\n- Automate release to Github using conventional commits/semantic releases.\n    - Currently [conventional-github-releaser] is used to achieve this (we've)\n      found this to be better than using `python-semantic-release` for this\n      purpose).\n\n## Setup\n\nThe most basic implementation using this Github action can be achieved by\ncreating a `release.yml` file within the `.github/workflows` directory with the\nfollowing contents:\n\n```yaml\nname: Release\non:\n  push:\n    branches:\n      - master\n\njobs:\n  release:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout Repository\n        uses: stjudecloud/release-python-action@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}\n```\n\nYou'll need to complete a few more steps to ensure things work correctly:\n\n- [ ] Add `python-semantic-release` to your dev dependencies (`poetry add -D python-semantic-release`).\n- [ ] Ensure the branch above matches your default branch. If your default \n      branch is `main`, be sure to change it both in the Github Action and\n      the `pyproject.yml` entry from `tool.semantic_release`! \n- [ ] Make sure you add a `PYPI_TOKEN` secret to your repository so that the\n      package can be published successfully.\n- [ ] Ensure you have a complete `pyproject.toml` file. You'll need to set the\n      appropriate settings for `python-semantic-release`, which you can find\n      documented\n      [here](https://python-semantic-release.readthedocs.io/en/latest/#getting-started).\n      We recommend using the following code snippet as a starting place.\n\n```toml\n[tool.semantic_release]\nbranch = \"master\"\nbuild_command = \"poetry build\"\ncommit_author = \"St. Jude Cloud \u003csupport@stjude.cloud\u003e\"\ncommit_message = \"\"\ncommit_subject = \"chore: bumping version to v{version}\"\nupload_to_release = \"false\"\nversion_source = \"commit\"\nversion_variable = \"pyproject.toml:version\"\n```\n\n## Support\n\nPlease file an issue on this repository if you encounter any issues.\n\n[Poetry]: https://python-poetry.org/\n[Conventional commits]: https://www.conventionalcommits.org/en/v1.0.0-beta.2/\n[python-semantic-release]: https://python-semantic-release.readthedocs.io/en/latest/\n[conventional-github-releaser]: https://www.npmjs.com/package/conventional-github-releaser\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstjudecloud%2Frelease-python-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstjudecloud%2Frelease-python-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstjudecloud%2Frelease-python-action/lists"}