@technote-space/github-action-config-helper
v2.1.11
Published
Helper for GitHub Action to manage config.
Downloads
113
Readme
GitHub Action Config Helper
Read this in other languages: English, 日本語.
アクション実行中のリポジトリから設定を取得する GitHub Actions のヘルパー
Table of Contents
使用方法
- インストール
npm i @technote-space/github-action-config-helper
import { getConfig } from '@technote-space/github-action-config-helper';
import { getInput } from '@actions/core';
import { context, GitHub } from '@actions/github';
...
const config = await getConfig('config.yml', new GitHub(getInput('GITHUB_TOKEN', {required: true})), context);
//const config = await getConfig('config.json', new GitHub(getInput('GITHUB_TOKEN', {required: true})), context, {ref: 'feature/change'}); // branch
//const config = await getConfig('config', new GitHub(getInput('GITHUB_TOKEN', {required: true})), context, {ref: 'v1.2.3'}); // tag
//const config = await getConfig('config.yml', new GitHub(getInput('GITHUB_TOKEN', {required: true})), context, {configPath: ''}); // default: '.github'
サポートされているファイルの種類
YAML
.yml
.yaml
JSON
その他の拡張子
e.g.
config.json
.eslintrc