GitHub Actions 开源项目最佳实践

1. 项目介绍

GitHub Actions 是 GitHub 提供的一个强大的自动化工具，它允许用户在 GitHub 仓库中创建自定义的工作流，以自动化软件开发生命周期中的各种任务。本项目是一个开源项目，收集了一系列可复用的 GitHub Actions，旨在帮助开发者通过自动化提高开发效率。

2. 项目快速启动

首先，确保您的系统中安装了 Node.js 和 Yarn。以下是启动项目的步骤：

# 克隆项目仓库
git clone https://github.com/marvinpinto/actions.git

# 进入项目目录
cd actions

# 安装项目依赖
yarn install

# 构建项目
yarn build

# 执行代码检查
yarn lint

# 运行测试
yarn test

# 修复代码风格问题
yarn lintfix

在以上步骤中，yarn lint 和 yarn lintfix 命令会帮助您确保代码风格的一致性，yarn test 用于执行测试用例，确保代码功能的正确性。

3. 应用案例和最佳实践

自动化发布

GitHub Actions 可以自动化发布流程。例如，您可以使用以下工作流自动上传资产、生成更改日志和预发布版本：

name: GitHub Automatic Releases

on:
  release:
    types: [published]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'
      - name: Install Dependencies
        run: yarn install
      - name: Build
        run: yarn build
      - name: Generate Release Notes
        uses: actions/create-release-notes@v1
      - name: Create Release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ github.ref }}
          release_name: Release ${{ github.ref }}
          draft: false
          prerelease: false
      - name: Upload Release Assets
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: ./path/to/your/asset
          asset_name: your-asset-file-name
          asset_content_type: application/zip

环境变量注入

在持续集成过程中，您可能需要注入环境变量。以下是如何使用 AWS SSM Parameter Store 中的密钥作为环境变量：

      - name: Set up AWS credentials
        uses: aws-actions/amazon-ssm-secrets-manager@v1
        with:
          region: 'us-west-2'
          secrets: {
            'my-secret': 'my-parameter-name',
            'my-other-secret': 'my-other-parameter-name'
          }

4. 典型生态项目

• Semantic Release: 一个用于自动化版本发布和生成更改日志的项目。
• Action-gh-release: 另一个用于自动化 GitHub 发布的项目。
• Keybase Notifications: 将 GitHub 通知发送到 Keybase Chat 通道、团队和 DM 的项目。

以上是一些与本项目相关的典型生态项目，它们可以帮助开发者进一步自动化和优化工作流程。