Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 2.29 KB

install.md

File metadata and controls

72 lines (48 loc) · 2.29 KB
Raw

Installation

This document describes how to install actionlint.

Homebrew on macOS

actionlint formula is provided by Homebrew officially.

brew install actionlint

And rhysd/actionlint repository also provides its own Homebrew package, which is automatically updated on new release. If you prefer it, tap the repository before running brew install.

brew tap "rhysd/actionlint" "https://github.com/rhysd/actionlint"
brew install actionlint

Prebuilt binaries

Download an archive file from the releases page for your platform, unarchive it and put the executable file to a directory in $PATH.

Prebuilt binaries are built at each release by CI for the following OS and arch:

  • macOS (x86_64, arm64)
  • Linux (i386, x86_64, arm32, arm64)
  • Windows (i386, x86_64, arm64)
  • FreeBSD (i386, x86_64)

Note: darwin/arm64 and windows/arm64 target binaries are not tested since the author doesn't have the environments.

Download script

To install actionlint executable with one command, the download script is available. It downloads the latest version of actionlint (actionlint.exe on Windows and actionlint on other OSes) to the current directory automatically. This is a recommended way if you install actionlint in some shell script.

bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)

For the usage of actionlint on GitHub Actions, see the usage document.

Docker image

See the usage document to know how to install and use an official actionlint Docker image.

Build from source

Recent Go toolchain is necessary to build actionlint from source. Use Go 1.16 or later.

# Install the latest stable version
go install github.com/rhysd/actionlint/cmd/actionlint@latest

# Install the head of main branch
go install github.com/rhysd/actionlint/cmd/actionlint

Checks | Usage | Configuration | Go API | References