GitHub Actions - Configure Pages 项目使用教程

GitHub Actions - Configure Pages 项目使用教程

1. 项目目录结构及介绍

configure-pages/
├── dist/
│   └── ...
├── src/
│   └── ...
├── .eslintrc.json
├── .gitignore
├── .node-version
├── .prettierignore
├── .prettierrc.yml
├── LICENSE
├── README.md
├── action.yml
├── package-lock.json
└── package.json

目录结构说明

• dist/: 存放编译后的文件。
• src/: 存放源代码文件。
• .eslintrc.json: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
• .node-version: 指定项目所需的 Node.js 版本。
• .prettierignore: Prettier 忽略文件配置，指定哪些文件或目录不需要被 Prettier 格式化。
• .prettierrc.yml: Prettier 配置文件，用于代码格式化。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• action.yml: GitHub Actions 的配置文件，定义了 Action 的行为。
• package-lock.json: 锁定项目依赖的版本。
• package.json: 项目的依赖管理文件，包含项目的元数据和依赖信息。

2. 项目的启动文件介绍

在 configure-pages 项目中，启动文件主要是 action.yml。这个文件定义了 GitHub Actions 的行为，包括输入、输出、运行环境等。

action.yml 文件内容概览

name: 'Configure Pages'
description: 'An action to enable Pages and extract various metadata about a site'
inputs:
  # 输入参数定义
  # ...
outputs:
  # 输出参数定义
  # ...
runs:
  using: 'node16'
  main: 'dist/index.js'

启动文件说明

• name: 定义了 Action 的名称。
• description: 描述了 Action 的功能。
• inputs: 定义了 Action 的输入参数。
• outputs: 定义了 Action 的输出参数。
• runs: 定义了 Action 的运行环境，使用 Node.js 16，并指定主入口文件为 dist/index.js。

3. 项目的配置文件介绍

.eslintrc.json

{
  "extends": "eslint:recommended",
  "rules": {
    // 自定义规则
  }
}

.prettierrc.yml

printWidth: 80
tabWidth: 2
useTabs: false
semi: true
singleQuote: true
trailingComma: 'es5'
bracketSpacing: true
arrowParens: 'always'

package.json

{
  "name": "configure-pages",
  "version": "1.0.0",
  "description": "A GitHub Action to enable Pages and extract various metadata about a site",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    // 依赖包
  },
  "devDependencies": {
    // 开发依赖包
  }
}

配置文件说明

• .eslintrc.json: 配置了 ESLint 的规则，确保代码风格一致。
• .prettierrc.yml: 配置了 Prettier 的格式化规则，确保代码格式统一。
• package.json: 定义了项目的元数据、依赖包、脚本命令等。

通过以上配置文件，可以确保项目的代码风格一致，并且能够顺利运行和测试。