gregoiref/addlicense
Add, check, update, and remove SPDX license headers across a repository. Downloads the pre-built binary from GitHub Releases — no Go toolchain required. Supports Linux, macOS, and Windows on amd64 and arm64.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| args | Arguments forwarded verbatim to the addlicense binary. Common patterns: --check . Check all files; fails if any header is missing (default). --check cmd/ internal/ Limit scope to specific directories. --license MIT --author "Acme" Inject MIT headers for a given author. --update . Update existing headers (year, author) without re-injecting. --remove . Strip all license headers. --ignore "*.pb.go" . Ignore generated files. --format json --check . Machine-readable output. --sbom sbom.spdx . Generate an SPDX 2.3 bill of materials. Pass an empty string ('') to install the binary without running it; subsequent steps can then call addlicense directly with custom arguments. | no | --check . |
| version | Version of the addlicense binary to download (e.g. "v1.0.1"). When the action is referenced by a release tag (e.g. uses: GregoireF/addlicense-action@v1), this defaults to that tag and no override is needed. Set this explicitly when: - Testing the action from a branch with uses: ./ - Pinning to a specific CLI version independently of the action tag - Running the action in a workflow_dispatch with a version input | no | "" |
Outputs
| name | description |
|---|---|
| version | The resolved version of addlicense that was installed (e.g. "v1.0.1"). Useful for logging, caching keys, or conditional steps. |