From ff42edcb94ae674e9b4e83c30de7c88abb59787d Mon Sep 17 00:00:00 2001
From: Rody Davis <rody.davis.jr@gmail.com>
Date: Sat, 13 Jun 2026 00:59:06 -0700
Subject: [PATCH] docs: add README files for all shared actions

---
 coolify-deploy/README.md          | 20 ++++++++++++++++++++
 enforce-flutter-version/README.md | 18 ++++++++++++++++++
 run-buildifier/README.md          | 18 ++++++++++++++++++
 setup-bazel/README.md             | 22 ++++++++++++++++++++++
 4 files changed, 78 insertions(+)
 create mode 100644 coolify-deploy/README.md
 create mode 100644 enforce-flutter-version/README.md
 create mode 100644 run-buildifier/README.md
 create mode 100644 setup-bazel/README.md

diff --git a/coolify-deploy/README.md b/coolify-deploy/README.md
new file mode 100644
index 0000000..807b2d7
--- /dev/null
+++ b/coolify-deploy/README.md
@@ -0,0 +1,20 @@
+# Deploy to Coolify
+
+Triggers a remote Coolify redeployment for a service/app using the Coolify webhook trigger URL and API access token.
+
+## Inputs
+
+| Name | Description | Required | Default |
+| :--- | :--- | :--- | :--- |
+| `webhook` | The webhook URL to trigger the deployment. | Yes | |
+| `token` | The bearer token to authorize the webhook call. | Yes | |
+
+## Example Usage
+
+```yaml
+- name: Deploy to Coolify
+  uses: rodydavis/shared-actions/coolify-deploy@main
+  with:
+    webhook: ${{ secrets.COOLIFY_WEBHOOK }}
+    token: ${{ secrets.COOLIFY_TOKEN }}
+```
diff --git a/enforce-flutter-version/README.md b/enforce-flutter-version/README.md
new file mode 100644
index 0000000..06f0ee5
--- /dev/null
+++ b/enforce-flutter-version/README.md
@@ -0,0 +1,18 @@
+# Enforce Flutter Version Constraint
+
+Recursively scans all `pubspec.yaml` files in the repository and verifies that their Flutter SDK environment constraints match the configured expected value. Non-Flutter/pure Dart packages are automatically skipped.
+
+## Inputs
+
+| Name | Description | Required | Default |
+| :--- | :--- | :--- | :--- |
+| `expected_version` | The exact Flutter SDK constraint string expected in the pubspec. | Yes | `^3.19.0` |
+
+## Example Usage
+
+```yaml
+- name: Verify Flutter SDK version constraint
+  uses: rodydavis/shared-actions/enforce-flutter-version@main
+  with:
+    expected_version: '^3.19.0'
+```
diff --git a/run-buildifier/README.md b/run-buildifier/README.md
new file mode 100644
index 0000000..07f5ac7
--- /dev/null
+++ b/run-buildifier/README.md
@@ -0,0 +1,18 @@
+# Run Buildifier
+
+Downloads and runs the Bazel buildifier tool in lint mode on Starlark files (like `BUILD.bazel`, `WORKSPACE`, `.bzl` files) to ensure they comply with standard formatting.
+
+## Inputs
+
+| Name | Description | Required | Default |
+| :--- | :--- | :--- | :--- |
+| `version` | The buildifier release version tag to download. | No | `v8.0.1` |
+
+## Example Usage
+
+```yaml
+- name: Format Check Starlark files
+  uses: rodydavis/shared-actions/run-buildifier@main
+  with:
+    version: 'v8.0.1'
+```
diff --git a/setup-bazel/README.md b/setup-bazel/README.md
new file mode 100644
index 0000000..371ecdd
--- /dev/null
+++ b/setup-bazel/README.md
@@ -0,0 +1,22 @@
+# Setup Bazel
+
+Installs Node.js, Bazelisk, and configures Git credentials to resolve private dependencies over SSH.
+
+## Inputs
+
+| Name | Description | Required | Default |
+| :--- | :--- | :--- | :--- |
+| `node_version` | The version of Node.js to install. | No | `24` |
+| `cache` | The package manager cache (e.g. `pnpm`, `npm`, `yarn`) to use with `actions/setup-node`. | No | |
+| `git_token` | Gitea access token used to authenticate SSH dependencies over HTTPS. | No | |
+
+## Example Usage
+
+```yaml
+- name: Set up Bazel Environment
+  uses: rodydavis/shared-actions/setup-bazel@main
+  with:
+    node_version: '24'
+    cache: 'pnpm'
+    git_token: ${{ secrets.GIT_TOKEN }}
+```