GitHub Actions新功能：等待外部构建系统状态

### 知识点 #### GitHub Action介绍 GitHub Action是GitHub平台提供的自动化工具，允许开发者自动化软件开发的各个阶段，从代码提交到CI/CD（持续集成与持续部署）。GitHub Actions可以针对特定的事件，如代码推送、Pull Request生成、定时任务等触发工作流（workflow），并在虚拟机中执行一系列命令。 #### 使用TypeScript创建GitHub Action GitHub Actions可以使用多种语言编写，包括JavaScript和TypeScript。TypeScript是JavaScript的一个超集，它在JavaScript的基础上添加了类型系统和对ES6+新特性的支持。通过使用TypeScript，开发者可以享受到更严格的类型检查和代码编辑器的智能提示，从而提升开发效率和代码质量。 #### 创建JavaScript操作的步骤 1. **使用模板创建新操作**：GitHub提供了一个模板仓库，可以帮助用户快速开始构建自己的GitHub Action。用户可以复制（使用“Use this template”按钮）这个模板到自己的仓库。 2. **安装依赖项**：使用npm（Node.js的包管理器）安装所需的依赖项。在本例中，执行命令`npm install`来安装。 3. **构建TypeScript代码**：TypeScript代码首先需要被编译成JavaScript代码才能在Node.js环境中运行。执行`npm run build`命令进行构建。 4. **打包操作**：构建后，需要将操作打包成一个可分发的格式，通常是压缩成一个ZIP文件。在模板中，可以通过`npm run pack`命令完成此操作。 5. **运行测试**：开发GitHub Action时，编写并运行测试非常重要，以确保操作的正确性。通过执行`npm test`来运行测试，并检查输出中是否显示所有测试已成功通过。 #### action.yml文件 `action.yml`文件是定义GitHub Action的关键，它包含了该Action的元数据和运行时行为。在`action.yml`中，需要指定操作的输入和输出，这样其他工作流可以依赖此操作并获取其输出数据。 - **输入（Inputs）**：可以定义其他GitHub工作流传递给该操作的输入参数。 - **输出（Outputs）**：可以定义此操作产生的输出参数，以便后续工作流使用。 #### 版本控制和发布 在创建GitHub Action后，可以对其进行版本控制和发布，以便其他用户和项目能够使用。版本控制通常使用语义化版本号（semver），并在发布时更新`action.yml`中的版本号。 ### 实际操作示例 假设我们正在开发一个名为`action-wait-for-status`的GitHub Action，其目的是等待外部构建系统的状态变更，然后根据状态做出相应的操作。以下是创建该Action的可能步骤： 1. **克隆模板仓库**：访问`action-wait-for-status`模板仓库页面，使用“Use this template”按钮复制到自己的GitHub账户。 2. **本地初始化**：将复制到本地，并初始化一个新的npm包。 ```bash git clone <template-repo-url> cd <action-name> npm init -y ``` 3. **安装TypeScript和其他依赖**：安装TypeScript及其编译器。 ```bash npm install typescript @types/node --save-dev ``` 4. **编写TypeScript代码**：在项目中编写TypeScript代码，实现等待外部构建系统状态的功能。 5. **配置TypeScript编译**：在项目根目录创建`tsconfig.json`文件，配置TypeScript编译选项。 6. **构建和测试**：编写npm脚本来编译TypeScript代码，并在`./dist`目录生成JavaScript文件。同时编写测试文件，并使用npm脚本运行它们。 ```bash npm run build npm run test ``` 7. **更新`action.yml`文件**：配置Action的输入输出参数。 8. **打包Action**：确保测试通过后，使用npm脚本打包Action到ZIP文件。 ```bash npm run pack ``` 9. **版本控制和发布**：一旦验证了Action的功能并且准备就绪，就可以推送到GitHub，并在GitHub仓库页面上发布一个新的版本。 10. **使用Action**：在其他GitHub仓库的工作流中，按照GitHub Actions的规范引用和使用发布的Action。 通过以上步骤，我们可以创建一个GitHub Action，即`action-wait-for-status`，它可以被整合到GitHub工作流中，帮助开发者在CI/CD过程中实现对构建系统状态的监控。