AWS CDK GitHub OIDC 项目启动和配置教程

AWS CDK GitHub OIDC 项目启动和配置教程

aws-cdk-github-oidc CDK constructs to use OpenID Connect for authenticating your Github Action workflow with AWS IAM 项目地址: https://gitcode.com/gh_mirrors/aw/aws-cdk-github-oidc

1. 项目的目录结构及介绍

AWS CDK GitHub OIDC 项目的主要目录结构如下：

aws-cdk-github-oidc/
├── .github/              # 存放 GitHub Actions 工作流文件
├── .projen/              # Projen 配置文件，用于自动化项目生成和维护
├── assets/               # 静态资源文件
├── src/                  # 源代码目录
│   └── index.ts          # 主程序文件
├── test/                 # 测试代码目录
├── .eslintrc.json        # ESLint 配置文件
├── .gitattributes         # Git 属性配置文件
├── .gitignore            # Git 忽略文件
├── .mergify.yml          # Mergify 配置文件，用于自动化代码审查流程
├── .npmignore            # npm 忽略文件
├── .nvmrc                # Node.js 版本管理文件
├── .projenrc.js          # Projen 配置脚本
├── API.md                # 项目 API 文档
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── package-lock.json     # npm 包锁定文件
├── package.json          # npm 包配置文件
└── tsconfig.dev.json     # TypeScript 配置文件

• .github/：存放 GitHub Actions 工作流文件，用于自动化 CI/CD 流程。
• .projen/：Projen 配置文件，用于自动化项目生成和维护。
• assets/：静态资源文件。
• src/：源代码目录。
• test/：测试代码目录。
• .eslintrc.json：ESLint 配置文件，用于代码风格检查。
• .gitattributes：Git 属性配置文件。
• .gitignore：Git 忽略文件。
• .mergify.yml：Mergify 配置文件，用于自动化代码审查流程。
• .npmignore：npm 忽略文件。
• .nvmrc：Node.js 版本管理文件。
• .projenrc.js：Projen 配置脚本。
• API.md：项目 API 文档。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。
• package-lock.json：npm 包锁定文件。
• package.json：npm 包配置文件。
• tsconfig.dev.json：TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/index.ts，以下是启动文件的主要内容：

export class GithubActionsIdentityProvider {
    // 构造函数和类方法
}

export class GithubActionsRole {
    // 构造函数和类方法
}

// 导出必要的类和函数
export { GithubActionsIdentityProvider, GithubActionsRole };

index.ts 文件定义了两个主要的类：GithubActionsIdentityProvider 和 GithubActionsRole，这两个类用于配置 GitHub Actions 作为 OpenID Connect 身份提供者和 AWS IAM 角色之间的关联。

3. 项目的配置文件介绍

项目的配置文件主要包括 .projenrc.js 和 package.json。

.projenrc.js

Projen 是一个用于自动化项目生成和维护的工具，.projenrc.js 文件是 Projen 的配置脚本，用于定义项目的配置信息。以下是一个简单的示例：

const { Project } = require('projen');

const project = new Project({
  name: 'aws-cdk-github-oidc',
  // 其他配置信息
});

project.synth();

package.json

package.json 文件定义了项目的依赖和脚本。以下是一个简化版的 package.json 文件内容：

{
  "name": "aws-cdk-github-oidc",
  "version": "1.0.0",
  "description": "AWS CDK constructs for GitHub OIDC authentication with AWS IAM",
  "main": "src/index.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    // 项目依赖
  },
  "devDependencies": {
    // 开发依赖
  }
}

在 scripts 部分，定义了一些常用的 npm 脚本，例如构建 (build) 和测试 (test)。这些脚本可以简化项目的构建和测试流程。

aws-cdk-github-oidc CDK constructs to use OpenID Connect for authenticating your Github Action workflow with AWS IAM 项目地址: https://gitcode.com/gh_mirrors/aw/aws-cdk-github-oidc