FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

driverforge/driverforge-github-action: Build Control4 drivers in GitHub Actions with the Driverforge CLI · GitHub

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

driverforge-github-action

Install the Driverforge CLI onto a GitHub Actions runner and optionally run a target (build, …) in one step. The customer-facing way to build and package Control4 drivers in CI.

Model: always install driverforge onto PATH, then optionally run a command. Omit the command for pure environment setup; pass command: build for a one-step package.

Usage

Environment setup only

driverforge is left on PATH for your own scripting in later steps:

- uses: driverforge/driverforge-github-action@v1
  with:
    version: '1.4.0'        # pinned, or 'latest'
- run: driverforge build -c release

Run a target directly (one-step packaging)

- uses: driverforge/driverforge-github-action@v1
  with:
    command: build
    project-dir: ./driver
    configuration: release
    increment: patch

Release build (exact version, encrypted, naked artifact name)

For release pipelines that stamp an explicit version and publish the artifact under the plain driver name (no -<configuration> suffix):

- uses: driverforge/driverforge-github-action@v1
  with:
    command: build
    project-dir: ./driver
    configuration: prod
    driver-version: '2026071501'
    encrypt: true
    no-suffix: true

Inputs

Input Description Default
version CLI version — pinned (1.4.0) or latest latest
command Target to run after install (e.g. build). Omit for setup-only ''
project-dir Driver project path (--project-dir / -p) ''
configuration Build configuration (--configuration / -c) ''
increment Version bump: major | minor | patch (--increment / -i) ''
driver-version Stamp an absolute driver <version> (--version). Mutually exclusive with increment ''
encrypt Force encryption on (true) or off (false); omit to keep the driver's setting ''
no-suffix Build a named configuration under the naked driver name (--no-suffix); false forces suffixing back on ''
sourcemap Emit a sourcemap (--sourcemap / -s) ''
unpack Keep unpacked output (--unpack / -u) ''
args Extra raw args appended to the invocation (escape hatch) ''
github-token Reserved; downloads are from public storage and need no token ''

To ship after building, set command: deploy or command: sync instead of build — shipping is its own CLI command that builds first, so there is no deploy/sync input.

Outputs

Output Description
version The resolved CLI version that was installed
driverforge-path Absolute path to the installed driverforge binary

How it works

Detects OS/arch → downloads the pinned release archive from releases.driverforge.com → verifies the SHA-256 checksum → caches it in the runner tool-cache (driverforge/<version>/<arch>) so repeat runs don't re-download → prepends it to PATH → if command is set, runs driverforge <command> with the mapped flags.

Supported runners: Linux and macOS (amd64 / arm64).

Contributing

Issues and pull requests are welcome — see CONTRIBUTING.md. This repo is a public mirror of a private monorepo, so accepted PRs land via an upstream import and show as closed (not merged) with your authorship preserved; the linked guide explains why. Please also read the Code of Conduct.

Security

Report vulnerabilities privately — see SECURITY.md. Please don't open public issues for security reports.

License

MIT — see LICENSE.

About

Build Control4 drivers in GitHub Actions with the Driverforge CLI

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages


Back | FazBrowse Home | New Git URL