开源项目 `wait-for-secrets` 使用教程

开源项目 wait-for-secrets 使用教程

wait-for-secretsPublish from GitHub Actions using multi-factor authentication项目地址:https://gitcode.com/gh_mirrors/wa/wait-for-secrets

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

wait-for-secrets 项目的目录结构如下：

wait-for-secrets/
├── github/
│   └── workflows/
│       ├── npm-publish.yml
│       ├── release.yml
├── dist/
├── images/
├── src/
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── SECURITY.md
├── action.yml
├── jest.config.ts
├── package-lock.json
├── package.json
└── tsconfig.json

目录介绍

• github/workflows/: 包含项目的 GitHub Actions 工作流配置文件。
  • npm-publish.yml: 用于发布到 NPM 的配置文件。
  • release.yml: 用于发布到 GitHub 的配置文件。
• dist/: 编译后的文件目录。
• images/: 项目中使用的图片资源。
• src/: 项目的源代码目录。
• tests/: 项目的测试代码目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• SECURITY.md: 项目安全相关说明文档。
• action.yml: GitHub Actions 的配置文件。
• jest.config.ts: Jest 测试框架的配置文件。
• package-lock.json: npm 依赖锁定文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 action.yml，这是一个 GitHub Actions 的配置文件，定义了 Action 的输入、输出和运行步骤。

action.yml 内容概览

name: 'Wait for Secrets'
description: 'Wait for the developer to enter secrets during a workflow run'
inputs:
  secrets:
    description: 'List of secrets to wait for'
    required: true
runs:
  using: 'node16'
  main: 'dist/index.js'

• name: Action 的名称。
• description: Action 的描述。
• inputs: 定义了 Action 的输入参数，例如 secrets。
• runs: 定义了 Action 的运行方式，使用 Node.js 16，并指定主文件为 dist/index.js。

3. 项目的配置文件介绍

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

package.json

package.json 文件定义了项目的依赖、脚本和其他元数据。

{
  "name": "wait-for-secrets",
  "version": "1.0.0",
  "description": "Wait for the developer to enter secrets during a workflow run",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "axios": "^0.21.1"
  },
  "devDependencies": {
    "@types/jest": "^26.0.20",
    "jest": "^26.6.3",
    "typescript": "^4.1.3"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的主入口文件。
• scripts: 定义了项目的构建和测试脚本。
• dependencies: 项目运行时的依赖。
• devDependencies: 项目开发时的依赖。

tsconfig.json

tsconfig.json 文件定义了 TypeScript 项目的编译选项。

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

• compilerOptions: 编译选项。
  • target: 编译目标

wait-for-secretsPublish from GitHub Actions using multi-factor authentication项目地址:https://gitcode.com/gh_mirrors/wa/wait-for-secrets