Add auto pypi release #210
Conversation
WalkthroughThis update introduces an automated workflow for publishing Python packages to PyPI via GitHub Actions. It activates upon a release event, streamlining the process of building, signing, and uploading package distributions. This ensures a secure and efficient delivery of updates to PyPI, enhancing trust and simplifying the release process for developers. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (1)
- .github/workflows/publish.yml (1 hunks)
Additional comments: 2
.github/workflows/publish.yml (2)
- 3-5: Ensure the trigger event configuration aligns with the intended use case. If additional release types should trigger this workflow, consider expanding the
typesarray.- 32-54: The publishing and signing steps are well-defined. However, verify the permissions set in line 36 and 37 are strictly necessary for the operations performed in this job to adhere to the principle of least privilege.
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.x' | ||
|
|
||
| - name: Build distributions | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| python -m pip install build | ||
| python -m build |
There was a problem hiding this comment.
The build process is correctly set up. However, consider caching the installed Python packages to speed up the workflow runs.
+ - name: Cache pip
+ uses: actions/cache@v3
+ with:
+ path: ~/.cache/pip
+ key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+ restore-keys: |
+ ${{ runner.os }}-pip-Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Build distributions | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install build | |
| python -m build | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Cache pip | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Build distributions | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install build | |
| python -m build |
| - name: publish | ||
| uses: pypa/[email protected] | ||
|
|
||
| - name: sign | ||
| uses: sigstore/[email protected] | ||
| with: | ||
| inputs: ./dist/*.tar.gz ./dist/*.whl | ||
| release-signing-artifacts: true |
There was a problem hiding this comment.
Consider adding error handling for the publishing and signing steps to manage failures gracefully.
+ - name: publish
+ uses: pypa/[email protected]
+ continue-on-error: true
+
+ - name: sign
+ uses: sigstore/[email protected]
+ with:
+ inputs: ./dist/*.tar.gz ./dist/*.whl
+ release-signing-artifacts: true
+ bundle-only: true
+ continue-on-error: trueCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| - name: publish | |
| uses: pypa/[email protected] | |
| - name: sign | |
| uses: sigstore/[email protected] | |
| with: | |
| inputs: ./dist/*.tar.gz ./dist/*.whl | |
| release-signing-artifacts: true | |
| - name: publish | |
| uses: pypa/[email protected] | |
| continue-on-error: true | |
| - name: sign | |
| uses: sigstore/[email protected] | |
| with: | |
| inputs: ./dist/*.tar.gz ./dist/*.whl | |
| release-signing-artifacts: true | |
| bundle-only: true | |
| continue-on-error: true |
Summary by CodeRabbit