feat: cut GitHub Release with curated collections zip on change

Author: ph33nx

.github/workflows/sync.yml

@@ -35,13 +35,39 @@ jobs:
           POSTMAN_API_KEY: ${{ secrets.POSTMAN_API_KEY }}
 
       - name: Commit regenerated specs, collections and UID cache
+        id: commit
         run: |
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
           git add specs collections collections.json
           if git diff --cached --quiet; then
             echo "No collection changes."
+            echo "changed=false" >> "$GITHUB_OUTPUT"
           else
             git commit -m "sync: update collections from live OpenAPI spec"
             git push
+            echo "changed=true" >> "$GITHUB_OUTPUT"
           fi
+
+      - name: Bundle collections and environment
+        id: bundle
+        if: steps.commit.outputs.changed == 'true' || (github.event_name == 'workflow_dispatch' && inputs.force)
+        run: |
+          tag="v$(date -u +'%Y.%m.%d-%H%M')"
+          mkdir -p bundle
+          cp collections/*.json environment/roxyapi.postman_environment.json bundle/
+          (cd bundle && zip -q -j ../roxyapi-collections.zip ./*.json)
+          echo "tag=$tag" >> "$GITHUB_OUTPUT"
+
+      - name: Publish release
+        if: steps.bundle.outcome == 'success'
+        uses: softprops/action-gh-release@v3
+        with:
+          tag_name: ${{ steps.bundle.outputs.tag }}
+          name: Collections ${{ steps.bundle.outputs.tag }}
+          body: |
+            Postman collections for the RoxyAPI catalog, auto-generated from the live OpenAPI specs.
+
+            Import `roxyapi-collections.zip` into Postman (every domain plus a RoxyAPI environment), or fork the [public workspace](https://www.postman.com/roxylabs-7113570/roxyapi). Set the `apiKey` variable to your key and every request authenticates through `X-API-Key`.
+          files: roxyapi-collections.zip
+          make_latest: 'true'

.gitignore

@@ -142,4 +142,8 @@ vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
 .vite/
 
-CLAUDE.md
+CLAUDE.md
+
+# Release bundle build artifacts (assembled in CI, attached to the GitHub Release)
+/bundle/
+roxyapi-collections.zip

AGENTS.md

@@ -43,4 +43,4 @@ bun run check            # biome lint and format
 
 ## Automation
 
-`.github/workflows/sync.yml` runs daily at 06:00 UTC, on manual dispatch, and on a `repository_dispatch` of type `openapi-updated`. It runs the live sync and commits any regenerated artifacts. `.github/workflows/ci.yml` runs lint, typecheck, and a dry run on every PR.
+`.github/workflows/sync.yml` runs daily at 06:00 UTC, on manual dispatch, and on a `repository_dispatch` of type `openapi-updated`. It runs the live sync, commits any regenerated artifacts, and when collections changed it cuts a dated GitHub Release with `roxyapi-collections.zip` (the 12 collections plus `environment/roxyapi.postman_environment.json`). A manual dispatch with `force: true` rebuilds everything and always cuts a release, useful for an on demand snapshot. `.github/workflows/ci.yml` runs lint, typecheck, and a dry run on every PR.

README.md

@@ -20,6 +20,8 @@ Open the public workspace and fork any collection into your own:
 
 Each forked collection carries its own `baseUrl` and an `apiKey` variable. Set `apiKey` to your key (from [your account](https://roxyapi.com/account)) and every request is authenticated through the `X-API-Key` header. That is the only setup.
 
+Prefer to import locally? Grab `roxyapi-collections.zip` from the [latest release](https://github.com/RoxyAPI/postman-collections/releases/latest): every domain collection plus a ready to use RoxyAPI environment, refreshed automatically whenever the collections change. Import the zip into Postman, set `apiKey`, done.
+
 Prefer Bruno or Insomnia? Both import RoxyAPI directly from a spec URL, no download needed:
 
 ```

environment/roxyapi.postman_environment.json

@@ -0,0 +1,14 @@
+{
+	"id": "2b1a9c64-7e3f-4d52-8a6b-0c1d2e3f4a5b",
+	"name": "RoxyAPI",
+	"values": [
+		{
+			"key": "apiKey",
+			"value": "",
+			"type": "secret",
+			"enabled": true
+		}
+	],
+	"_postman_variable_scope": "environment",
+	"_postman_exported_using": "RoxyAPI/postman-collections"
+}