使用 GitHub Actions 格式化並檢查您的 Python 程式碼

在不斷發展的軟體開發領域，維持程式碼品質和一致性至關重要。確保程式碼庫保持乾淨並遵守最佳實踐的最有效方法之一是自動化格式化和 linting 流程。在這篇文章中，我們將逐步介紹如何設定 GitHub Actions 工作流程，旨在自動執行 Python 專案的程式碼格式化和 linting。我們將探討配置和所涉及的步驟，以及它如何節省您的時間並減少程式碼中的錯誤。

GitHub Actions 簡介

GitHub Actions 是一個強大的工具，可讓您直接在 GitHub 儲存庫中自動化工作流程。從運行測試到部署應用程序，GitHub Actions 可以根據推送、拉取請求等事件處理各種任務。在此範例中，我們將重點放在使用 GitHub Actions 自動化程式碼格式化和 linting。

工作流程分解

以下是用於格式化和檢查 Python 程式碼的 GitHub Actions 工作流程的詳細介紹：

name: Format and Lint

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

jobs:
  format-and-lint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.9'  # Specify the Python version to use

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install black isort autopep8

      - name: Run Black
        run: black .

      - name: Run isort
        run: isort .

      - name: Run autopep8
        run: autopep8 --in-place --recursive .

      - name: Commit changes if any
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          # Check for changes
          git diff --exit-code || {
            echo "Changes detected. Committing changes..."

            # Configure Git user
            git config --global user.name "github-actions"
            git config --global user.email "actions@github.com"

            # Stage all changes
            git add .

            # Commit changes
            git commit -m "Apply code formatting and linting fixes"

            # Push changes
            git push origin HEAD
          }

工作流程組件解釋

1. 觸發事件：

   on:
     push:
       branches:
         - master
     pull_request:
       branches:
         - master

工作流程在向主分支推送和拉取請求時觸發。這確保了對主分支或拉取請求的每次變更都會自動格式化和檢查。

1. 作業配置：

   jobs:
     format-and-lint:
       runs-on: ubuntu-latest

該作業在最新版本的 Ubuntu 上運作。這是進行格式化和 linting 的環境。

1. 結帳代碼：

   - name: Checkout code
     uses: actions/checkout@v3

此步驟檢查您的儲存庫程式碼，允許後續步驟存取和修改它。

1. 設定 Python：

   - name: Set up Python
     uses: actions/setup-python@v4
     with:
       python-version: '3.9'

此步驟在工作流程環境中設定 Python 3.9。調整此項目以符合您專案中使用的 Python 版本。

1. 安裝依賴項：

   - name: Install dependencies
     run: |
       python -m pip install --upgrade pip
       pip install black isort autopep8

這裡安裝了用於格式化和 linting 的基本 Python 套件 — black、isort 和 autopep8。

1. 執行格式化程式：

   - name: Run Black
     run: black .

   - name: Run isort
     run: isort .

   - name: Run autopep8
     run: autopep8 --in-place --recursive .

這些步驟使用黑色應用程式碼格式，使用 isort 進行匯入排序，使用 autopep8 進行其他格式調整。

1. 提交更改：

   - name: Commit changes if any
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     run: |
       git diff --exit-code || {
         echo "Changes detected. Committing changes..."

         git config --global user.name "github-actions"
         git config --global user.email "actions@github.com"

         git add .
         git commit -m "Apply code formatting and linting fixes"
         git push origin HEAD
       }

如果進行了格式或 linting 更改，此步驟將提交並將它們推回儲存庫。它使用 GitHub 令牌進行身份驗證，並使用通用使用者設定 Git 進行提交。

此工作流程的好處

1. 一致性：確保程式碼遵循一致的格式規則，提高可讀性和可維護性。
2. 自動化：自動化格式化和檢查過程，減少手動幹預和潛在錯誤。
3. 整合：與您的 GitHub 儲存庫無縫集成，自動執行程式碼變更檢查。

結論

實作 GitHub Actions 工作流程進行格式化和 linting 是維護專案中程式碼品質和一致性的明智方法。透過自動化這些過程，您可以更專注於編寫程式碼，而不是格式化問題。此處提供的工作流程可作為堅實的基礎，但您可以根據專案的特定需求進一步進行自訂。立即開始將此工作流程整合到您的儲存庫中，體驗自動化程式碼品質管理的好處！

以上是使用 GitHub Actions 格式化並檢查您的 Python 程式碼的詳細內容。更多資訊請關注PHP中文網其他相關文章！