开源项目 `create-envfile` 使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00753/article/details/141623309

开源项目 `create-envfile` 使用教程

create-envfileGithub Action to create a .env file with Github Secrets项目地址:https://gitcode.com/gh_mirrors/cr/create-envfile

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

create-envfile 项目的目录结构相对简单，主要包含以下几个部分：

create-envfile/
├── README.md
├── action.yml
├── dist/
│   ├── index.js
│   └── index.js.map
├── package.json
└── src/
    └── index.ts

README.md: 项目说明文档，包含项目的基本介绍、使用方法和示例。
action.yml: GitHub Actions 的配置文件，定义了该 Action 的输入、输出和运行环境。
dist/: 编译后的 JavaScript 文件，包含 index.js 和其源映射文件 index.js.map。
package.json: 项目的依赖管理文件，包含项目的依赖库和脚本命令。
src/: 源代码目录，包含 TypeScript 源文件 index.ts。

2. 项目的启动文件介绍

项目的启动文件是 dist/index.js，这是从 src/index.ts 编译生成的 JavaScript 文件。该文件负责读取 GitHub Actions 的输入参数，并生成相应的 .env 文件。

3. 项目的配置文件介绍

项目的配置文件是 action.yml，它定义了 GitHub Actions 的配置，包括：

name: Action 的名称。
description: Action 的描述。
inputs: 输入参数，如 envkey_DEBUG、envkey_SOME_API_KEY 等。
runs: 运行配置，指定使用 node12 运行 dist/index.js。

以下是 action.yml 的部分内容示例：

name: 'Create envfile'
description: 'Create an .env file with GitHub Secrets'
inputs:
  envkey_DEBUG:
    description: 'Debug mode'
    required: false
  envkey_SOME_API_KEY:
    description: 'API key'
    required: false
  envkey_SECRET_KEY:
    description: 'Secret key'
    required: false
runs:
  using: 'node12'
  main: 'dist/index.js'

通过以上配置，用户可以在 GitHub Actions 中使用该 Action 生成包含 GitHub Secrets 的 .env 文件。

create-envfileGithub Action to create a .env file with Github Secrets项目地址:https://gitcode.com/gh_mirrors/cr/create-envfile