GitHub Actions - 空环境秘密

服务器

GitHub Actions 是 GitHub 提供的一项功能强大的自动化工具，它可以让开发者在代码仓库中执行各种任务和操作。其中一个非常有用的功能是使用 GitHub Actions 的空环境秘密，它可以帮助我们安全地存储和使用敏感信息，如 API 密钥、密码等。在本文中，我们将介绍如何在 GitHub Actions 中使用空环境秘密，并提供一个案例代码来演示其用法。

什么是空环境秘密

空环境秘密是 GitHub Actions 中用于存储和使用敏感信息的一种机制。与常规环境变量不同，空环境秘密的值不会直接暴露给 Actions 的执行环境。相反，空环境秘密的值会被加密并存储在 GitHub 服务器上。只有在 Actions 执行过程中，通过使用特定的语法来引用秘密，才能将其解密并在工作流中使用。

如何使用空环境秘密

使用空环境秘密非常简单。首先，我们需要在 GitHub 仓库的 "Settings" 页面中创建一个空环境秘密。在 "Secrets" 部分，点击 "New repository secret" 按钮，然后输入秘密的名称和值，并保存。

在工作流文件中，我们可以通过 ${{ secrets.SECRET_NAME }} 的语法来引用空环境秘密。在执行工作流时，GitHub Actions 会自动将该语法解析为真实的秘密值，并将其传递给工作流中的步骤或操作。

示例代码

接下来，让我们通过一个简单的示例来演示如何在 GitHub Actions 中使用空环境秘密。假设我们有一个 Node.JS 项目，需要使用一个私有的 API 密钥来访问某个服务。我们可以将该 API 密钥存储为一个空环境秘密，并在工作流中使用它。

首先，我们需要在 GitHub 仓库的 "Settings" 页面中创建一个名为 "API_KEY" 的空环境秘密，并将其值设置为我们的 API 密钥。

接下来，在我们的工作流文件中，我们可以通过以下方式来使用该秘密：

yaml
name: 使用空环境秘密的工作流
on:
  push:
    branches:
      - mAIn
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: 检出仓库
        uses: actions/checkout@v2
      - name: 安装依赖
        run: npm install
      - name: 运行测试
        run: npm test
      - name: 使用 API 密钥进行部署
        run: |
          echo ${{ secrets.API_KEY }} > api_key.txt
          # 在这里使用 api_key.txt 文件中的 API 密钥进行部署操作

在上面的示例中，我们定义了一个名为 "使用空环境秘密的工作流" 的工作流。它在 "push" 事件发生时触发，并且只在 "mAIn" 分支上运行。

工作流的主要步骤包括检出仓库、安装依赖、运行测试以及使用 API 密钥进行部署。在最后一步中，我们使用了 ${{ secrets.API_KEY }} 的语法来引用空环境秘密，并将其值写入一个名为 "api_key.txt" 的文件中。我们可以在这一步中执行任何需要使用 API 密钥的操作。

GitHub Actions 的空环境秘密是一个非常有用的功能，它可以帮助我们安全地存储和使用敏感信息。在本文中，我们介绍了如何在 GitHub Actions 中使用空环境秘密，并提供了一个使用案例代码来演示其用法。通过正确使用空环境秘密，我们可以更好地保护我们的敏感信息，并确保代码仓库的安全性。