《pre-commit Action 安装与配置指南》

《pre-commit Action 安装与配置指南》

action a GitHub action to run `pre-commit` 项目地址: https://gitcode.com/gh_mirrors/action4/action

1. 项目基础介绍

pre-commit 是一个用于自动化代码格式化、linting 和其他预提交检查的工具。它通过在提交代码前运行一系列的钩子（hooks）来确保代码的质量和一致性。本项目是一个GitHub Action，可以轻松地将 pre-commit 集成到你的GitHub工作流程中。

主要编程语言：Python

2. 项目使用的关键技术和框架

本项目使用的关键技术包括：

• GitHub Actions：GitHub提供的自动化工作流程服务。
• pre-commit：一个管理代码预提交钩子的Python库。
• YAML：用于定义GitHub Actions工作流程的配置文件格式。

3. 项目安装和配置的准备工作及详细步骤

准备工作

在开始之前，请确保你已经具备以下条件：

• 一个GitHub账号。
• 一个GitHub仓库。
• 基本的命令行操作知识。
• 对GitHub Actions有基本的了解。

安装步骤

步骤 1：创建工作流程文件

在你的GitHub仓库中，创建一个名为 .github/workflows/pre-commit.yml 的工作流程文件。

name: pre-commit

on:
  pull_request:
  push:

branches:
  - main

jobs:
  pre-commit:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-python@v3
    - uses: pre-commit/action@v3.0.1

步骤 2：配置 pre-commit

在你的仓库的根目录下，创建或更新一个名为 .pre-commit-config.yaml 的配置文件。这个文件将定义你要运行的钩子。以下是一个示例配置文件：

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v3.0.0
    hooks:
      - id: flake8
      - id: isort

这个配置文件定义了两个钩子：flake8 和 isort，它们将分别在提交前检查Python代码风格和排序。

步骤 3：测试你的工作流程

在你的本地仓库进行一些更改，并推送这些更改到GitHub。你应该会看到GitHub Actions自动运行 pre-commit 钩子，并对你的代码进行检查。

结束语

通过以上步骤，你已经成功地将 pre-commit Action集成到你的GitHub工作流程中。现在，每次提交和拉取请求都将自动运行预提交检查，以确保代码质量和一致性。

action a GitHub action to run `pre-commit` 项目地址: https://gitcode.com/gh_mirrors/action4/action