GitHub Actions 및 Commitizen을 사용하여 Python 라이브러리 릴리스 자동화-파이썬 튜토리얼-php.cn

Automating Python Library Releases Using GitHub Actions and Commitizen

소개

Python 라이브러리를 유지 관리하는 것은 어려울 수 있으며, 특히 새 버전을 출시하는 경우에는 더욱 그렇습니다. 이 프로세스를 수동으로 수행하면 시간이 많이 걸리고 오류가 발생하기 쉽습니다. 이 게시물에서는 GitHub Actions 및 Commitizen을 사용하여 릴리스 프로세스를 자동화하는 방법을 안내하겠습니다. 이 접근 방식을 사용하면 릴리스의 일관성, 의미론적 버전 관리(semver) 준수, 변경 로그를 최신 상태로 유지하는 동시에 수동 개입을 줄일 수 있습니다.

의미적 버전 관리란 무엇입니까?

Semantic Versioning(semver)은 MAJOR.MINOR.PATCH 형식의 세 숫자를 사용하는 버전 관리 체계입니다. 이 체계는 각 릴리스의 변경 사항을 전달하는 명확하고 예측 가능한 방법을 제공합니다.

주요: 획기적인 변경 사항 - 이전 버전과 호환되지 않는 모든 것
사소: 새로운 기능이지만 이전 버전과 호환됩니다.
패치: 버그 수정 - 이전 버전과 완전히 호환됩니다.

의미적 버전 관리는 개발자가 종속성을 효과적으로 관리하는 데 도움이 되기 때문에 매우 중요합니다. 새 버전의 라이브러리에 주요 변경 사항(예: 마이너 또는 패치 업데이트)이 적용되지 않는다는 사실을 알게 되면 애플리케이션 중단에 대한 걱정 없이 자신있게 종속성을 업데이트할 수 있습니다.

semver에 대한 자세한 내용은 semver.org를 확인하세요.

커미티즌 소개

Commitizen은 커밋 메시지를 표준화하고 버전 관리 및 변경 로그 생성을 자동화하는 도구입니다. 특정 커밋 메시지 형식을 적용함으로써 Commitizen은 필요한 버전 변경 유형(주, 부 또는 패치)을 결정하고 변경 로그를 자동으로 생성할 수 있습니다.

커밋 메시지 형식은 다음 구조를 따릅니다.

<commit-type>(<topic>): the commit message

로그인 후 복사

커밋 유형:
- feat: 새로운 기능을 나타냅니다. 이로 인해 마이너 버전 충돌이 발생할 수 있습니다. 커밋에 주요 변경 사항 메모가 포함되어 있으면 주요 버전이 변경됩니다.
- 수정: 버그 수정을 나타내며 패치 버전이 올라갑니다.
- chore, ci 및 기타: 버전 충돌을 유발하지 않습니다.

예:

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

로그인 후 복사

이 예에서 Feat 커밋 내의 주요 변경 사항 메모는 주요 버전 범프를 유발합니다. 이러한 일관성을 통해 버전 번호가 올바른 변경 수준을 전달할 수 있으며 이는 라이브러리를 사용하는 사용자에게 매우 중요합니다.

커밋 구성

Commitizen을 Python 프로젝트와 통합하려면 pyproject.toml 파일에서 이를 구성해야 합니다. 다음은 추가해야 할 구성입니다.

[tool.commitizen]
name = "cz_conventional_commits"
version = "0.1.0"
tag_format = "v$version"
version_files = [
    "pyproject.toml:version",
]
update_changelog_on_bump = true

로그인 후 복사

설명:

name: 사용할 커밋 메시지 규칙을 지정합니다. 우리는 일반적인 커밋 형식을 사용하고 있습니다.
버전: 프로젝트의 현재 버전입니다. "0.1.0" 또는 초기 버전으로 시작해야 합니다.
tag_format: v$version이 일반적인 형식(v1.0.0, v1.1.0 등)인 태그 형식을 정의합니다.
version_files: 버전 번호가 추적되는 파일을 나열합니다. 이 설정을 사용하면 pyproject.toml의 버전 번호가 자동으로 업데이트됩니다.
update_changelog_on_bump: 버전 범프가 발생할 때마다 CHANGELOG.md 파일을 자동으로 업데이트합니다.

릴리스 프로세스를 자동화하는 이유는 무엇입니까?

릴리스를 수동으로 관리하는 것은 지루하고 오류가 발생하기 쉬울 수 있으며, 특히 프로젝트가 성장함에 따라 더욱 그렇습니다. 자동화는 다음과 같은 몇 가지 주요 이점을 제공합니다.

일관성: 버전 범프와 변경 로그가 매번 동일한 방식으로 처리되도록 보장합니다.
효율성: 새 버전 출시에 필요한 수동 단계를 줄여 시간을 절약합니다.
정확성: 변경 로그 업데이트를 잊어버리거나 버전을 잘못 적용하는 등 인적 오류를 최소화합니다.

개요: 자동 릴리즈 프로세스

자동화 작동 방식을 명확하게 보여주기 위해 대략적인 개요를 제공합니다.

메인 병합 시: 풀 요청(PR)이 메인 브랜치에 병합되면 워크플로는 커밋 메시지를 확인하고, 버전 변경이 필요한지 결정하고, 변경 로그를 업데이트하고, 필요한 경우 릴리스에 태그를 지정합니다. .
태그 생성 시: 태그가 푸시되면(새 릴리스를 나타냄) 워크플로는 새 버전을 PyPI에 게시하고 해당 변경 로그가 있는 GitHub 릴리스를 생성합니다.

워크플로 분할: 이벤트 병합과 태그 이벤트

단순성과 명확성을 위해 자동화를 두 가지 워크플로로 나누겠습니다.

Merge to Main Workflow
On Tag Creation Workflow

Workflow 1: On Merge to Main

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:

Trigger: This workflow is triggered when a new commit is pushed to the main branch.
Concurrency: The concurrency setting ensures that only one instance of the workflow runs at a time for the main branch, preventing race conditions and duplicate version bumps.
bump job: It checks whether the commit message starts with ‘bump:’, which indicates an automated commit from the previous release. If not, Commitizen determines the necessary version bump based on the commit messages, updates the CHANGELOG.md, and creates a new tag.

Workflow 2: On Tag Creation

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:

Trigger: This workflow is triggered by a tag push (e.g., v1.2.0).
Concurrency: The concurrency setting ensures that only one instance of the workflow runs for each tag, preventing issues like multiple release attempts for the same version.
detect-release-parameters job: Extracts the changelog notes for the release.
release job: Builds the package and publishes it to PyPI using Poetry.
release-github job: Creates a new GitHub release with the generated release notes.

Setting Up the Personal Access Token

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:

Go to your repository on GitHub.
Navigate to Settings > Secrets and variables > Actions.
Click on New repository secret.
Add a secret with the name PERSONAL_ACCESS_TOKEN and paste your PAT in the value field.

This token is crucial because it allows the workflow to push changes (like the updated changelog and version bump) back to the repository.

Generated CHANGELOG.md Example

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.

Common Issues and Troubleshooting

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.

Conclusion and Next Steps

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.

Call to Action

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!