package
1.7.1
Repository: https://github.com/rhysd/actionlint.git
Documentation: pkg.go.dev

# README

generate-popular-actions

This is a script for generating popular_actions.go.

It does:

  • Fetches metadata of popular actions
  • 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:

KeyDescriptionExampleRequired?
slugGitHub repository slug"actions/checkout"Yes
tagsKnown release tags["v1", "v2", "v3", "v4"]Yes
nextThe next release tag. Empty means new version won't be detected"v5"No
pathAbsolute path to the action from the repository root"/path/to/action"No
skip_inputsSkipping checking inputs of this action or nottrueNo
skip_outputsSkipping checking outputs of this action or nottrueNo
file_extFile extension of action metadata file. The default is "yml""yaml"No

Alternative actions registry JSON file can be used via -r option.