开源项目 `setup-elixir` 使用教程

开源项目 setup-elixir 使用教程

setup-elixirSet up your GitHub Actions workflow with OTP and Elixir项目地址:https://gitcode.com/gh_mirrors/se/setup-elixir

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

setup-elixir 是一个 GitHub Actions 项目，用于在 GitHub Actions 工作流中设置 Elixir 环境。以下是该项目的目录结构：

setup-elixir/
├── .github/
│   └── workflows/
│       └── main.yml
├── dist/
│   └── index.js
├── src/
│   ├── main.js
│   └── utils.js
├── .gitignore
├── action.yml
├── package.json
└── README.md

目录结构介绍

• .github/workflows/main.yml: 定义了 GitHub Actions 的工作流配置。
• dist/index.js: 打包后的主文件。
• src/main.js: 项目的主逻辑文件。
• src/utils.js: 项目中使用的工具函数。
• .gitignore: 指定不需要跟踪的文件和目录。
• action.yml: 定义了 GitHub Actions 的元数据。
• package.json: 项目的依赖和脚本配置。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/main.js，它包含了设置 Elixir 环境的主要逻辑。以下是该文件的简要介绍：

const core = require('@actions/core');
const tc = require('@actions/tool-cache');
const path = require('path');
const utils = require('./utils');

async function run() {
  try {
    const version = core.getInput('elixir-version');
    const otpVersion = core.getInput('otp-version');
    const cache = core.getInput('cache');

    // 下载并安装 Elixir 和 Erlang
    const elixirPath = await utils.downloadElixir(version, otpVersion, cache);

    // 设置环境变量
    core.addPath(path.join(elixirPath, 'bin'));

    core.info(`Successfully setup Elixir version ${version} with OTP version ${otpVersion}`);
  } catch (error) {
    core.setFailed(error.message);
  }
}

run();

启动文件介绍

• 引入依赖: 引入了 @actions/core, @actions/tool-cache, path 和 ./utils 模块。
• run 函数: 主函数，负责下载和安装 Elixir 和 Erlang，并设置环境变量。
• 输入参数: 从 GitHub Actions 的输入中获取 elixir-version, otp-version 和 cache 参数。
• 下载和安装: 调用 utils.downloadElixir 函数下载并安装 Elixir 和 Erlang。
• 设置环境变量: 将 Elixir 的 bin 目录添加到系统路径中。

3. 项目的配置文件介绍

项目的配置文件是 action.yml，它定义了 GitHub Actions 的元数据和输入参数。以下是该文件的简要介绍：

name: 'Setup Elixir'
description: 'Set up your GitHub Actions workflow with a specific version of Elixir and Erlang/OTP'
inputs:
  elixir-version:
    description: 'The version of Elixir to use'
    required: true
  otp-version:
    description: 'The version of Erlang/OTP to use'
    required: true
  cache:
    description: 'Cache the Elixir and Erlang/OTP installation'
    required: false
    default: 'true'
runs:
  using: 'node12'
  main: 'dist/index.js'

配置文件介绍

• name: 定义了 Action 的名称。
• description: 描述了 Action 的功能。
• inputs: 定义了输入参数，包括 elixir-version, otp-version 和 cache。
• runs: 定义了运行时使用的环境（node12）和主文件（dist/index.js）。

通过以上介绍，您可以更好地理解和使用 setup-elixir 项目。希望这份文档对您有所帮助！

setup-elixirSet up your GitHub Actions workflow with OTP and Elixir项目地址:https://gitcode.com/gh_mirrors/se/setup-elixir