From 6cb6f49d01c448420324d98c9d5d56e78435a3b5 Mon Sep 17 00:00:00 2001
From: nfebe <fenn25.fn@gmail.com>
Date: Tue, 11 Aug 2026 01:14:04 +0100
Subject: [PATCH] docs: Prepare the first tagged release

Nothing has ever been tagged here, so the pinning the README recommends resolves to nothing and
every documented example fails. Records what the first release contains, and points the examples
at a CLI version whose commands cover the whole agent API.
---
 CHANGELOG.md            | 21 +++++++++++++++++++++
 README.md               |  2 +-
 examples/deploy.yml     |  2 +-
 setup-flatrun/README.md |  2 +-
 4 files changed, 24 insertions(+), 3 deletions(-)
 create mode 100644 CHANGELOG.md

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
 ```