阿里云凭证配置 GitHub 动作教程
1. 项目目录结构及介绍
阿里云configure-aliyun-credentials-action
项目是为GitHub Actions设计的一个Action,用于在GitHub工作流中配置阿里云的凭证环境变量。该项目的主要目录结构如下:
.
├── README.md # 项目说明文档
├── action.yml # GitHub Actions 主动作文件
└── lib # 内部实现逻辑的JavaScript代码
└── index.js # 主要功能实现
README.md
: 提供了关于该动作的详细文档和使用示例。action.yml
: GitHub Actions的工作流程定义文件,描述了此Action如何被调用和执行。lib/index.js
: JavaScript代码,实现了从输入参数获取并设置阿里云凭证的功能。
2. 项目启动文件介绍
启动文件主要指的是action.yml
,它是GitHub Actions中的工作流程定义文件。在configure-aliyun-credentials-action
项目中,action.yml
负责接收输入参数并执行相应的操作来配置阿里云凭证。例如,它会处理oidc-provider-arn
, role-to-assume
和 audience
等输入,然后设置环境变量如ALIYUN_ACCESS_KEY_ID
和ALIYUN_ACCESS_KEY_SECRET
。
name: 'Configure Alibaba Cloud Credentials'
description: 'Configure Alibaba Cloud credentials for GitHub Actions'
inputs:
oidc-provider-arn:
description: 'Optional: The ARN of OIDC provider'
required: false
role-to-assume:
description: 'Optional: The ARN of role to assume'
required: false
audience:
description: 'The audience to use for the OIDC provider'
required: false
default: 'github-actions'
runs:
using: 'node12'
main: 'lib/index.js'
3. 项目的配置文件介绍
在configure-aliyun-credentials-action
项目中,配置主要通过GitHub Actions的工作流程文件.github/workflows
中的YAML文件完成。在你的仓库中,你需要创建一个这样的YAML文件,引入并使用这个Action来配置阿里云凭证。以下是一个简单的例子:
name: 'Example Workflow'
on: [push]
jobs:
configure-creds:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Configure Aliyun Credentials
uses: aliyun/configure-aliyun-credentials-action@v1
with:
oidc-provider-arn: 'your_OIDC_PROVIDER_ARN'
role-to-assume: 'your_ROLE_TO_ASSUME'
audience: 'github-actions'
在这个示例中,oidc-provider-arn
, role-to-assume
, 和 audience
参数需要替换为你自己的实际值。一旦配置成功,后续的GitHub Actions步骤就能访问到这些阿里云凭证,以便进行API调用或资源管理。