freckle/Platform setup

Install and configure PlatformCLI and Stackctl

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit Jul 10, 2026
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: freckle/setup-platform-action@5d1466d1f6c1eb29382f2139d93023dc19838ffe # v7.10.0

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
version	The version of PlatformCLI to install. Do not include the `v` prefix here. The default is to lookup the latest release. We recommend using this default, along with specifying a `required_version` constraint (such as `=~ 3`) in your `.platform.yaml`.	no	—
token	A GitHub access token with rights to fetch the private PlatformCLI release artifacts. Either this or `github-app-{id,private-key}` must be given.	no	—
github-app-id	Provide this (and `github-private-key`) instead of `token` to generate and use one from the identified App.	no	—
github-private-key	Provide this (and `github-app-id`) instead of `token` to generate and use one from the identified App.	no	—
github-app-private-key	Deprecated, use github-private-key	no	—
app-directory	If present, this will be set as `PLATFORM_APP_DIRECTORY` for the remainder of the workflow. For details on what this affects, see `platform(1)`.	—	""
environment	If present, this will be set as `PLATFORM_ENVIRONMENT` for the remainder of the workflow. For details on what this affects, see `platform(1)`.	no	—
resource	If present, this will be set as `PLATFORM_RESOURCE` for the remainder of the workflow. For details on what this affects, see `platform(1)`.	no	—
no-validate	If present, this will be set as `PLATFORM_NO_VALIDATE` for the remainder of the workflow. For details on what this affects, see `platform(1)`.	no	—
stackctl-version	The version of Stackctl to install. Do not include the `v` prefix here. The default is to lookup the latest release.	no	—
stackctl-directory	Value to set as STACKCTL_DIRECTORY	—	.platform/specs
stackctl-filter	Value to set as STACKCTL_FILTER	no	—
fetch-platform-yaml	Automatically fetch `.platform.yaml` via GitHub API if not present. This can be useful to avoid a checkout if all your Job needs is this file. This will always use `github.token`, regardless of our own `token` input.	—	true

Outputs

name	description
tag	A consistent, source-specific value that should be used throughout build/push/deploy actions. It's currently the head sha for `pull_request` events, the "after" sha for `push` events, and `github.sha` for all other events
cache	Path to the `.platform/cache` directory, for which we've setup an `actions/cache` step. This output is only useful if in a multi-app repository.