diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8f00ed6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +All notable changes to the FlatRun GitHub Actions are documented in this file. + +## [1.0.0] - 2026-08-11 + +First tagged release. The actions were usable from `main` before this, but nothing resolved +`@v1`, which is what the README tells people to pin, so every documented example was broken. + +### Added + +- `setup-flatrun` installs a pinned FlatRun CLI release on the runner and puts it on `PATH`, + taking the binary from the release assets and caching it in the runner tool cache. The source + repository can be overridden to install from a fork. +- A `v1` tag that moves with each 1.x release, so `@v1` tracks the latest without a workflow edit, + alongside the exact `v1.0.0` tag for anyone pinning strictly. + +### Changed + +- The examples install CLI 0.3.0, the first version whose command surface covers the whole agent + API. diff --git a/README.md b/README.md index 8c92da3..1534b24 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ jobs: steps: - uses: flatrun/actions/setup-flatrun@v1 with: - version: 0.1.0 + version: 0.3.0 - run: flatrun deployment deploy api env: FLATRUN_URL: ${{ vars.FLATRUN_URL }} diff --git a/examples/deploy.yml b/examples/deploy.yml index fdac622..c24df3a 100644 --- a/examples/deploy.yml +++ b/examples/deploy.yml @@ -13,7 +13,7 @@ jobs: - uses: flatrun/actions/setup-flatrun@v1 with: - version: 0.1.0 + version: 0.3.0 - name: Roll out the new image run: flatrun deployment deploy api --pull diff --git a/setup-flatrun/README.md b/setup-flatrun/README.md index d0b05d8..c230921 100644 --- a/setup-flatrun/README.md +++ b/setup-flatrun/README.md @@ -7,7 +7,7 @@ Downloads a pinned release of the [FlatRun CLI](https://github.com/flatrun/cli), ```yaml - uses: flatrun/actions/setup-flatrun@v1 with: - version: 0.1.0 + version: 0.3.0 - run: flatrun version ```