GitHub Actions 入门指南
GitHub Actions 是内置在 GitHub 平台中的自动化功能。它允许您在存储库中自动化工作流,包括软件构建、测试和部署。作为开发人员,拥有此功能可以简化您的工作流程并提高工作效率。
创建 Workflow File
要设置 GitHub Action,首先需要在存储库中创建一个工作流文件。
- 在 GitHub 存储库中,导航到 Actions 选项卡
- 点击 New workflow
- GitHub 会根据你的项目推荐一些工作流模板。对于这个例子,选择 Set up a workflow yourself
- GitHub 将在 .github/workflows 目录中创建一个新的 YAML 文件
理解 Workflow File
让我们介绍一些有关工作流文件的基础知识:
name: CI
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run a one-line script
run: echo Hello, world!
- name: Run a multi-line script
run: |
echo Add other actions to build,
echo test, and deploy your project.
下面是在 YAML 文件中发生的事情:
- name : 这是您的工作流的名称,你可以给它起任何你喜欢的名字。
- on : 指定触发工作流的事件。在上面的示例中,只要有对主分支的推或拉请求,工作流就会触发。
- jobs : 这是您定义组成工作流的作业的地方。每个作业将在 run-on 指定的自己的虚拟环境中运行。
- steps : 步骤是构成工作的各个任务。
自定义 Workflow
您可以自定义工作流以适应项目的需要。例如,您可能希望设置一个工作流,以便在向存储库推送代码时自动测试代码。
steps:
- uses: actions/checkout@v2
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '18'
- name: Install dependencies
run: npm ci
- name: Run tests
run: npm test
在修改后的示例中,工作流首先 checkout 您的存储库,然后使用 Actions/setup-node@v2 设置 node.js,然后使用 npm ci 安装项目的依赖项,并最终通过 npm test 进行测试。
您可以根据需要添加任意多的步骤,甚至可以根据前面步骤的结果有条件地运行步骤。这为您在自动化工作方面提供了很大的灵活性。
我的开源项目
评论已关闭