This action is designed to simplify integration testing for applications that use Firebolt database. This action will create a database, an engine and start the engine.
There are two major versions of this action, one per Firebolt generation:
| Version | Firebolt | Branch | Status |
|---|---|---|---|
@v2 |
Firebolt 2.0 | master |
Active development. New changes go here. |
@v1 |
Firebolt 1.0 | releases/v1 |
Maintenance only. Largely deprecated. |
- firebolt-client-id - Service account it to use for authentication
- firebolt-client-secret - Service account secret to use for authentication
- instance-type [Optional] - Engine instance type
- db_suffix [Optional] - A suffix to append to database name
- engine-scale [Optional] - Scale of an engine
- api-endpoint [Optional] - Environment endpoint to use to connect (Default:
api.app.firebolt.io) - engine-version [Optional] - Setup a specific engine version
- region [Optional] - Deprecated
For the Firebolt 1.0 (@v1) inputs, see the README on the releases/v1 branch.
Releases are made with the Release workflow (Actions → Release → Run workflow):
- In Use workflow from, pick the branch to release:
masterfor v2,releases/v1for v1. - Enter the version using semantic versioning, e.g.
2.7.0. Its major version must match the branch, otherwise the workflow fails.
The workflow checks that the committed bundle in dist/ is up to date, creates the vX.Y.Z tag and GitHub release, and moves the major version tag (e.g. v2) to it. This ensures all calls to this action with a major version tag use the latest release.
When a new Firebolt generation starts, move master to a new releases/vN branch and bump MAINLINE_MAJOR in .github/workflows/release.yml on master.