环境变量

环境变量提供了一种安全方式,用于在工作流中管理配置值和密钥,包括 API 密钥以及工作流需要访问的其他敏感数据。密钥不会写入工作流定义,但在执行期间仍可使用。

变量类型

TradingGoose 中的环境变量分为两个层级:

  • 个人环境变量:仅属于你的账户,只有你能查看和使用
  • 工作区环境变量:在整个工作区共享,所有团队成员均可使用

当名称冲突时,工作区环境变量优先于个人环境变量。

设置环境变量

从工作区导航打开 Environment。在顶部选择 Workspace 或 Personal 视图,再使用对应的创建按钮添加该作用域的变量。

选择作用域

在 Workspace 视图创建共享密钥,在 Personal 视图创建账户专用密钥。当前视图决定新变量的作用域;不存在每个变量独立的工作区作用域开关。

工作区变量视图

工作区变量与个人变量在不同视图显示,不会混在同一列表中。切换视图即可管理另一作用域。工作流执行时可以解析两种作用域的变量,同名时工作区值优先。

在工作流中使用变量

要在工作流中引用环境变量,请使用 {{}} 语法。在任意输入框中输入 {{ 时,会弹出下拉列表,同时显示你的个人环境变量和工作区级环境变量。选择要使用的变量即可。

变量优先级

当个人变量和工作区变量同名时:

  1. 工作区变量优先于个人变量
  2. 这样可避免命名冲突,并确保团队工作流行为一致
  3. 如果已存在同名工作区变量,则忽略该个人变量

选择变量名时请谨慎,以免发生意外覆盖。可考虑为个人变量加上姓名缩写前缀,或为工作区变量加上项目名称前缀。

安全最佳实践

敏感数据

  • 将 API 密钥、令牌和密码存为环境变量,不要硬编码
  • 多人共用的资源使用工作区变量
  • 个人凭据保存在个人变量中

变量命名

  • 使用描述性名称:DATABASE_URL,而不是 DB
  • 在团队中遵循统一的命名约定
  • 考虑使用前缀以避免冲突:PROD_API_KEY、DEV_API_KEY

访问控制

  • 工作区环境变量遵循工作区权限
  • 仅具有写入或更高权限的用户可以创建/修改工作区变量
  • 个人变量始终仅对用户本人可见