GitHub Action for Serverless Framework 环境变量配置详解

GitHub Action for Serverless Framework 环境变量配置详解

【免费下载链接】github-action :zap::octocat: A Github Action for deploying with the Serverless Framework 项目地址: https://gitcode.com/gh_mirrors/githuba/github-action

GitHub Action for Serverless Framework 是一款强大的工具，能帮助开发者轻松实现 Serverless 应用的自动化部署。本文将详细介绍如何在该 GitHub Action 中配置环境变量，确保你的 Serverless 项目安全、高效地运行。

为什么环境变量配置至关重要？

在 Serverless 应用开发中，环境变量扮演着关键角色。它们用于存储敏感信息（如 API 密钥、数据库凭证）、配置应用行为（如服务端点、调试模式）以及区分开发/生产环境。正确配置环境变量不仅能保障项目安全，还能提高部署灵活性和可维护性。

基础环境变量配置方法

直接在 workflow 文件中定义

最常见的环境变量配置方式是在 GitHub Action 的 workflow 文件中直接声明。以下是一个典型示例：

- name: serverless deploy
  uses: serverless/github-action@v3.2
  with:
    args: deploy
  env:
    SERVERLESS_ACCESS_KEY: ${{ secrets.SERVERLESS_ACCESS_KEY }}
    # 或直接使用 AWS 凭证
    # AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
    # AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

在这个示例中，env 关键字下定义了 SERVERLESS_ACCESS_KEY 环境变量，并通过 GitHub Secrets 安全获取其值。这种方式适用于大多数基础部署场景。

使用 GitHub Secrets 管理敏感信息

为了保护敏感数据，强烈建议使用 GitHub Secrets 存储环境变量值。具体步骤如下：

1. 在 GitHub 仓库页面导航至 Settings > Secrets and variables > Actions
2. 点击 New repository secret 添加新的密钥
3. 在 workflow 文件中通过 ${{ secrets.SECRET_NAME }} 引用

这种方法确保敏感信息不会直接暴露在代码中，有效降低安全风险。

高级配置：多环境变量与命令组合

当需要配置多个环境变量或结合复杂命令时，可以使用 entrypoint 和 args 参数实现更灵活的配置：

- name: Install Plugin and Deploy
  uses: serverless/github-action@v3.2
  with:
    args: -c "serverless plugin install --name <plugin-name> && serverless deploy"
    entrypoint: /bin/sh
  env:
    PLUGIN_API_KEY: ${{ secrets.PLUGIN_API_KEY }}
    DEPLOY_ENV: production

这个示例展示了如何在执行部署命令前安装插件，并同时配置多个环境变量。通过 /bin/sh 作为入口点，可以执行任意 Shell 命令组合。

常见问题解决：环境变量不生效

路径问题导致的环境变量无法读取

如果遇到 "This command can only be run in a Serverless service directory" 错误，可能是工作目录不正确导致环境变量无法被 Serverless 框架读取。解决方案如下：

- name: Enter dir and deploy
  uses: serverless/github-action@v3.2
  with:
    args: -c "cd ./<your-dir> && serverless deploy"
    entrypoint: /bin/sh
  env:
    SERVERLESS_ACCESS_KEY: ${{ secrets.SERVERLESS_ACCESS_KEY }}

通过显式切换到 Serverless 服务目录，确保环境变量能被正确加载。

不同 Serverless 版本的环境变量差异

如果你使用的是 Serverless v1 或 v2，环境变量配置方式基本一致，但需要注意 Action 版本的选择：

# Serverless v1
uses: serverless/github-action@v1

# Serverless v2
uses: serverless/github-action@v2

确保 Action 版本与你的 Serverless 框架版本相匹配，以避免环境变量处理逻辑的兼容性问题。

最佳实践总结

1. 敏感信息必用 Secrets：所有凭证、密钥等敏感数据必须通过 GitHub Secrets 管理
2. 环境变量分组：按功能或环境（开发/测试/生产）对环境变量进行分组管理
3. 明确命名规范：使用清晰的命名（如 AWS_PROD_ACCESS_KEY）区分不同环境的变量
4. 最小权限原则：为环境变量分配最小必要权限，降低泄露风险
5. 版本控制：通过 Action 版本锁定（如 @v3.2）确保环境变量配置的稳定性

通过遵循这些最佳实践，你可以充分发挥环境变量的作用，构建安全、可靠的 Serverless 自动化部署流程。

参考资料

• 官方文档：LICENSE
• 项目源码：Dockerfile

【免费下载链接】github-action :zap::octocat: A Github Action for deploying with the Serverless Framework 项目地址: https://gitcode.com/gh_mirrors/githuba/github-action