GitHub Actions Dhall 项目教程

GitHub Actions Dhall 项目教程

github-actions-dhallTypecheck, template and modularize your Github Action definitions with Dhall项目地址:https://gitcode.com/gh_mirrors/gi/github-actions-dhall

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

GitHub Actions Dhall 项目的目录结构如下：

github-actions-dhall/
├── README.md
├── dhall
│   ├── action.dhall
│   ├── defaults.dhall
│   └── inputs.dhall
├── examples
│   └── example.dhall
└── scripts
    └── generate.sh

目录介绍

• README.md: 项目说明文档。
• dhall/: 包含 Dhall 配置文件的目录。
  • action.dhall: 定义 GitHub Actions 的主要配置。
  • defaults.dhall: 包含默认配置选项。
  • inputs.dhall: 定义输入参数。
• examples/: 示例配置文件目录。
  • example.dhall: 一个示例 Dhall 配置文件。
• scripts/: 包含脚本的目录。
  • generate.sh: 用于生成配置文件的脚本。

2. 项目的启动文件介绍

项目的启动文件是 dhall/action.dhall。这个文件定义了 GitHub Actions 的主要配置，包括步骤、运行环境、输入输出等。

action.dhall 文件内容示例

let Prelude = https://prelude.dhall-lang.org/v17.0.0/package.dhall

let inputs = ./inputs.dhall

let defaults = ./defaults.dhall

let action =
  { name = "Example Action"
  , runs =
      [ { run = "echo Hello, World!"
        , env = defaults.env
        }
      ]
  , inputs = inputs
  }

in  action

3. 项目的配置文件介绍

项目的配置文件主要位于 dhall/ 目录下，包括 action.dhall、defaults.dhall 和 inputs.dhall。

defaults.dhall 文件内容示例

{ env =
    { API_KEY = "default-api-key"
    , SECRET = "default-secret"
    }
}

inputs.dhall 文件内容示例

{ api_key =
    { description = "API key for the service"
    , required = True
    }
, secret =
    { description = "Secret for the service"
    , required = False
    }
}

这些配置文件定义了 GitHub Actions 的默认环境变量和输入参数，确保了项目的灵活性和可配置性。

github-actions-dhallTypecheck, template and modularize your Github Action definitions with Dhall项目地址:https://gitcode.com/gh_mirrors/gi/github-actions-dhall