Mengekalkan perpustakaan Python boleh menjadi mencabar, terutamanya apabila ia datang untuk mengeluarkan versi baharu. Proses ini boleh memakan masa dan terdedah kepada ralat jika dilakukan secara manual. Dalam siaran ini, saya akan memandu anda mengautomasikan proses keluaran menggunakan GitHub Actions and Commitizen. Pendekatan ini memastikan keluaran anda konsisten, mematuhi versi semantik (semver) dan memastikan log perubahan anda dikemas kini—semuanya sambil mengurangkan campur tangan manual.
Versi Semantik (semver) ialah skema versi yang menggunakan tiga nombor dalam format MAJOR.MINOR.PATCH. Skim ini menyediakan cara yang jelas dan boleh diramal untuk menyampaikan perkara yang telah berubah dalam setiap keluaran:
Versi Semantik adalah penting kerana ia membantu pembangun mengurus kebergantungan dengan berkesan. Apabila anda mengetahui bahawa versi baharu pustaka tidak memperkenalkan perubahan pecah (cth., kemas kini kecil atau tampalan), anda boleh mengemas kini kebergantungan anda dengan yakin tanpa rasa takut aplikasi anda rosak.
Untuk butiran lanjut tentang semver, anda boleh menyemak semver.org.
Commitizen ialah alat yang menyeragamkan mesej komit dan mengautomasikan pembuatan versi dan log perubahan. Dengan menguatkuasakan format mesej komitmen tertentu, Commitizen boleh menentukan jenis bonjolan versi yang diperlukan (utama, kecil atau tampalan) dan menjana log perubahan secara automatik.
Format mesej komit mengikut struktur ini:
<commit-type>(<topic>): the commit message
Contohnya:
feat(parser): add support for parsing new file formats
fix(api): handle null values in the response
feat(api): change response of me endpoint BREAKING CHANGE: changes the API signature of the parser function
Dalam contoh ini, nota BREAKING CHANGE dalam komit prestasi akan mencetuskan bonggol versi utama. Ketekalan ini memastikan nombor versi anda menyampaikan tahap perubahan yang betul, yang penting untuk pengguna yang bergantung pada pustaka anda.
Untuk menyepadukan Commitizen dengan projek Python anda, anda perlu mengkonfigurasinya dalam fail pyproject.toml anda. Di bawah ialah konfigurasi yang perlu anda tambahkan:
[tool.commitizen]
name = "cz_conventional_commits"
version = "0.1.0"
tag_format = "v$version"
version_files = [
"pyproject.toml:version",
]
update_changelog_on_bump = true
Penjelasan:
Mengurus keluaran secara manual boleh membosankan dan terdedah kepada ralat, terutamanya apabila projek anda berkembang. Automasi membawa beberapa faedah utama:
Untuk memberi anda gambaran yang jelas tentang cara automasi berfungsi, berikut ialah gambaran keseluruhan peringkat tinggi:
Untuk kesederhanaan dan kejelasan, kami akan membahagikan automasi kepada dua aliran kerja:
This workflow handles the logic of detecting changes and bumping the version:
name: Merge to Main
on:
push:
branches:
- "main"
concurrency:
group: main
cancel-in-progress: true
jobs:
bump:
if: "!startsWith(github.event.head_commit.message, 'bump:')"
runs-on: ubuntu-latest
steps:
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Checkout Repository
uses: actions/checkout@v4
with:
token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
fetch-depth: 0
- name: Create bump and changelog
uses: commitizen-tools/commitizen-action@0.21.0
with:
github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
branch: main
Explanation:
This workflow is triggered when a tag is pushed, and it handles the release process:
name: On Tag Creation
on:
push:
tags:
- 'v*'
concurrency:
group: tag-release-${{ github.ref }}
cancel-in-progress: true
jobs:
detect-release-parameters:
runs-on: ubuntu-latest
outputs:
notes: ${{ steps.generate_notes.outputs.notes }}
steps:
- name: Setup Python
uses: actions/setup-python@v5
- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Get release notes
id: generate_notes
uses: anmarkoulis/commitizen-changelog-reader@v1.2.0
with:
tag_name: ${{ github.ref }}
changelog: CHANGELOG.md
release:
runs-on: ubuntu-20.04
needs: detect-release-parameters
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install poetry
- name: Configure pypi token
run: |
poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
- name: Build and publish package
run: |
poetry publish --build
release-github:
runs-on: ubuntu-latest
needs: [release, detect-release-parameters]
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Create Release Notes File
run: |
echo "${{ join(fromJson(needs.detect-release-parameters.outputs.notes).notes, '') }}" > release_notes.txt
- name: Create GitHub Release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
VERSION: ${{ github.ref_name }}
run: |
gh release create ${{ github.ref }} \
--title "Release $VERSION" \
--notes-file "release_notes.txt"
Explanation:
To ensure the workflows can perform actions like creating commits and tagging releases, you’ll need to set up a Personal Access Token (PAT) in your GitHub repository:
This token is crucial because it allows the workflow to push changes (like the updated changelog and version bump) back to the repository.
After running the workflows, a CHANGELOG.md file will be generated and updated automatically. Here’s an example of what it might look like:
## v2.0.0 (2021-03-31) ### Feat - **api**: change response of me endpoint ## v1.0.1 (2021-03-30) ### Fix - **api**: handle null values in the response ## v1.0.0 (2021-03-30) ### Feat - **parser**: add support for parsing new file formats
This CHANGELOG.md is automatically updated by Commitizen each time a new version is released. It categorizes changes into different sections (e.g., Feat, Fix), making it easy for users and developers to see what's new in each version.
Finally, here’s what a GitHub release looks like after being created by the workflow:
Incorrect Token Permissions: If the workflow fails due to permission errors, ensure that the PAT has the necessary scopes (e.g., repo, workflow).
Commitizen Parsing Issues: If Commitizen fails to parse commit messages, double-check the commit format and ensure it's consistent with the expected format.
Bump Commit Conflicts: If conflicts arise when the bump commit tries to merge into the main branch, you might need to manually resolve the conflicts or adjust your workflow to handle them.
Concurrent Executions: Without proper concurrency control, multiple commits or tags being processed simultaneously can lead to issues like duplicate version bumps or race conditions. This can result in multiple commits with the same version or incomplete releases. To avoid this, we’ve added concurrency settings to both workflows to ensure only one instance runs at a time for each branch or tag.
Automating the release process of your Python library with GitHub Actions and Commitizen not only saves time but also ensures consistency and reduces human errors. With this setup, you can focus more on developing new features and less on the repetitive tasks of managing releases.
As a next step, consider extending your CI/CD pipeline to include automated testing, code quality checks, or even security scans. This would further enhance the robustness of your release process.
If you found this post helpful, please feel free to share it with others who might benefit. I’d love to hear your thoughts or any questions you might have in the comments below. Have you implemented similar workflows in your projects? Share your experiences!
Atas ialah kandungan terperinci Mengautomasikan Keluaran Pustaka Python Menggunakan Tindakan GitHub dan Commitizen. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!
![[Web front-end] Permulaan pantas Node.js](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
