Semantic Release Action 使用教程
1. 项目的目录结构及介绍
cycjimmy/semantic-release-action/
├── docs/
│ └── README.md
├── src/
│ └── index.js
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .npmignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── action.yml
├── index.js
├── package-lock.json
├── package.json
└── release.config.js
- docs/: 包含项目的文档文件,如
README.md
。 - src/: 包含项目的源代码文件,如
index.js
。 - .editorconfig: 配置文件,用于统一代码风格。
- .gitattributes: 配置文件,用于指定文件的属性。
- .gitignore: 配置文件,用于指定不需要纳入版本管理的文件。
- .npmignore: 配置文件,用于指定发布到 npm 时不需要包含的文件。
- CODE_OF_CONDUCT.md: 行为准则文件。
- LICENSE: 许可证文件。
- README.md: 项目说明文件。
- action.yml: GitHub Action 的配置文件。
- index.js: 项目的入口文件。
- package-lock.json: npm 依赖锁定文件。
- package.json: npm 包配置文件。
- release.config.js: 发布配置文件。
2. 项目的启动文件介绍
项目的启动文件是 index.js
,它是整个 GitHub Action 的入口点。该文件负责初始化和执行 Semantic Release 的相关任务。
3. 项目的配置文件介绍
- action.yml: 这是 GitHub Action 的主要配置文件,定义了 Action 的输入、输出、环境变量等。
name: 'Semantic Release'
description: 'GitHub Action for Semantic Release'
inputs:
github_token:
description: 'GitHub token'
required: true
npm_token:
description: 'NPM token'
required: false
runs:
using: 'node12'
main: 'index.js'
- release.config.js: 这是 Semantic Release 的配置文件,用于自定义发布流程的各个步骤。
module.exports = {
branches: ['main'],
plugins: [
'@semantic-release/commit-analyzer',
'@semantic-release/release-notes-generator',
'@semantic-release/npm',
'@semantic-release/github'
]
};
通过这些配置文件,可以灵活地调整和定制 Semantic Release 的行为,以满足不同项目的需求。