# README
generate-popular-actions
This is a script for generating popular_actions.go
.
It does:
- Fetches metadata of popular actions
- from https://github.com
- from JSONL file in local
- Generates the fetched data set of metadata
- as Go source file
- as JSONL file
Usage
Generate Go source:
go run ./scripts/generate-popular-actions ./popular_actions.go
Detect new releases on GitHub:
go run ./scripts/generate-popular-actions -d
Please see output of -help
flag for more details.
The data source file
The data source of the popular actions is defined in popular_actions.json
. This file contains an array
of each action registry. Each registry is a JSON object containing the following keys:
Key | Description | Example | Required? |
---|---|---|---|
slug | GitHub repository slug | "actions/checkout" | Yes |
tags | Known release tags | ["v1", "v2", "v3", "v4"] | Yes |
next | The next release tag. Empty means new version won't be detected | "v5" | No |
path | Absolute path to the action from the repository root | "/path/to/action" | No |
skip_inputs | Skipping checking inputs of this action or not | true | No |
skip_outputs | Skipping checking outputs of this action or not | true | No |
file_ext | File extension of action metadata file. The default is "yml" | "yaml" | No |
Alternative actions registry JSON file can be used via -r
option.