Switch to document-instance API and simplify action

Migrate the action to the new CodeForge document-instance API and simplify behavior. API client now targets /document-instance/... and returns checks_started and logs_url; token verification URL and API_BASE were adjusted. The action no longer reads or uploads a spec file, no longer supports per-SDK targeting or polling/waiting for completion, and removed related inputs (spec_path, sdk_ids, wait_for_completion, fail_on_error) and outputs (status, generation_urls, published_packages) in favor of checks_started and logs_url. README and action.yml were updated to reflect the new "document instance" terminology and GitHub Variables usage for CODEFORGE_SPEC_ID. Also bumped package version to 1.1.0 and updated code to match the simplified payload and outputs.

Author: ALagoni97

README.md

@@ -1,6 +1,7 @@
 # CodeForge SDK Generation Action
 
-Automatically trigger SDK regeneration on [CodeForge](https://code-forge.net) when your OpenAPI specification changes.
+Automatically trigger SDK regeneration on [CodeForge](https://code-forge.net)
+when your OpenAPI specification changes.
 
 ## Quick Start
 
@@ -21,29 +22,23 @@ jobs:
       - name: Trigger SDK Generation
         uses: code-forge/generation-action@v1
         with:
-          spec_id: ${{ secrets.CODEFORGE_SPEC_ID }}
+          spec_id: 4aa2cde8-3978-4b0a-b9b8-4fef6d440e0e
           api_token: ${{ secrets.CODEFORGE_API_TOKEN }}
-          spec_path: api/openapi.yaml
 ```
 
 ## Inputs
 
-| Input | Required | Default | Description |
-|-------|----------|---------|-------------|
-| `spec_id` | Yes | — | CodeForge spec ID (find in the platform UI) |
-| `api_token` | Yes | — | CodeForge API token (generate in Account Settings) |
-| `spec_path` | Yes | — | Path to your OpenAPI spec file in the repo (e.g. `api/openapi.yaml`) |
-| `sdk_ids` | No | all SDKs | Comma-separated SDK IDs to regenerate |
-| `wait_for_completion` | No | `true` | Wait for generation to complete before finishing the step |
-| `fail_on_error` | No | `true` | Fail the workflow if SDK generation fails |
+| Input       | Required | Description                                              |
+| ----------- | -------- | -------------------------------------------------------- |
+| `spec_id`   | Yes      | CodeForge document instance ID (find in the platform UI) |
+| `api_token` | Yes      | CodeForge API token (generate in Account Settings)       |
 
 ## Outputs
 
-| Output | Description |
-|--------|-------------|
-| `status` | Generation status: `success`, `failed`, or `in_progress` |
-| `generation_urls` | Comma-separated URLs to view logs on CodeForge |
-| `published_packages` | JSON array of published package info (name, version, registry_url) |
+| Output           | Description                                   |
+| ---------------- | --------------------------------------------- |
+| `checks_started` | Number of generation checks that were started |
+| `logs_url`       | URL to view generation logs on CodeForge      |
 
 ### Using Outputs
 
@@ -52,149 +47,48 @@ jobs:
   id: generate
   uses: code-forge/generation-action@v1
   with:
-    spec_id: ${{ secrets.CODEFORGE_SPEC_ID }}
+    spec_id: 4aa2cde8-3978-4b0a-b9b8-4fef6d440e0e
     api_token: ${{ secrets.CODEFORGE_API_TOKEN }}
-    spec_path: api/openapi.yaml
 
-- name: Print published packages
-  run: echo "${{ steps.generate.outputs.published_packages }}"
+- name: Print logs URL
+  run: echo "${{ steps.generate.outputs.logs_url }}"
 ```
 
 ## Setup Guide
 
-### 1. Get your Spec ID
+### 1. Get your Document Instance ID
 
 1. Log in to [code-forge.net](https://code-forge.net)
-2. Navigate to your spec in the platform UI
-3. The spec ID is shown in the URL: `code-forge.net/specs/**spec_123**/...`
+2. Navigate to your document instance in the platform UI
+3. The ID is shown in the URL:
+   `code-forge.net/platform/document-instances/**your-id**/...`
 
 ### 2. Generate an API Token
 
 1. Go to **Account Settings** → **API Tokens**
 2. Click **Generate New Token**
 3. Copy the token (it will only be shown once)
 
-### 3. Add Secrets to GitHub
+### 3. Add your API Token to GitHub
 
-1. Go to your repository → **Settings** → **Secrets and variables** → **Actions**
-2. Add `CODEFORGE_SPEC_ID` with your spec ID
-3. Add `CODEFORGE_API_TOKEN` with your API token
-
-## Examples
-
-### Basic — Regenerate All SDKs
-
-```yaml
-- uses: code-forge/generation-action@v1
-  with:
-    spec_id: ${{ secrets.CODEFORGE_SPEC_ID }}
-    api_token: ${{ secrets.CODEFORGE_API_TOKEN }}
-    spec_path: openapi.yaml
-```
-
-### Regenerate Specific SDKs Only
-
-```yaml
-- uses: code-forge/generation-action@v1
-  with:
-    spec_id: ${{ secrets.CODEFORGE_SPEC_ID }}
-    api_token: ${{ secrets.CODEFORGE_API_TOKEN }}
-    spec_path: openapi.yaml
-    sdk_ids: sdk_789,sdk_012
-```
-
-### Fire-and-Forget (Don't Wait for Completion)
-
-```yaml
-- uses: code-forge/generation-action@v1
-  with:
-    spec_id: ${{ secrets.CODEFORGE_SPEC_ID }}
-    api_token: ${{ secrets.CODEFORGE_API_TOKEN }}
-    spec_path: openapi.yaml
-    wait_for_completion: false
-```
-
-### Continue Even if Generation Fails
-
-```yaml
-- uses: code-forge/generation-action@v1
-  with:
-    spec_id: ${{ secrets.CODEFORGE_SPEC_ID }}
-    api_token: ${{ secrets.CODEFORGE_API_TOKEN }}
-    spec_path: openapi.yaml
-    fail_on_error: false
-```
-
-### Full Example with Multiple SDKs and Outputs
-
-```yaml
-name: Regenerate SDKs on Spec Change
-
-on:
-  push:
-    branches: [main]
-    paths:
-      - 'api/openapi.yaml'
-
-jobs:
-  generate-sdks:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Trigger SDK Generation
-        id: generate
-        uses: code-forge/generation-action@v1
-        with:
-          spec_id: ${{ secrets.CODEFORGE_SPEC_ID }}
-          api_token: ${{ secrets.CODEFORGE_API_TOKEN }}
-          spec_path: api/openapi.yaml
-          sdk_ids: sdk_typescript,sdk_python,sdk_go
-          wait_for_completion: true
-          fail_on_error: true
-
-      - name: Print results
-        run: |
-          echo "Status: ${{ steps.generate.outputs.status }}"
-          echo "Logs: ${{ steps.generate.outputs.generation_urls }}"
-          echo "Packages: ${{ steps.generate.outputs.published_packages }}"
-```
+1. Go to your repository → **Settings** → **Secrets and variables** →
+   **Actions**
+2. Under **Secrets**, add `CODEFORGE_API_TOKEN` with your API token
 
 ## Troubleshooting
 
 ### `Invalid CodeForge API token`
 
-- Verify the token is correctly copied to your GitHub secret (no trailing spaces)
+- Verify the token is correctly copied to your GitHub secret (no trailing
+  spaces)
 - Check the token hasn't expired or been revoked in Account Settings
 - Ensure the secret name in your workflow matches (`CODEFORGE_API_TOKEN`)
 
-### `Spec not found` (404)
-
-- Double-check the `spec_id` value — it should match the ID shown in the CodeForge platform URL
-- Confirm the API token has access to this spec
-
-### `Invalid OpenAPI spec`
-
-- Your `openapi.yaml` file contains validation errors
-- Run a local validator (e.g. `npx @redocly/cli lint openapi.yaml`) before pushing
-
-### `No such file or directory` for spec_path
-
-- The `spec_path` input must be relative to the repository root
-- Ensure the file exists and the path is correct (e.g. `api/openapi.yaml`, not `/api/openapi.yaml`)
-- Make sure `actions/checkout@v4` runs before this action
-
-### `Generation timeout`
-
-- Generation took longer than the 5-minute default polling window
-- Set `wait_for_completion: false` to trigger generation without waiting, and check the CodeForge platform directly
-- If this happens frequently, contact CodeForge support
-
-### `SDK generation failed`
+### `Specification not found` (404)
 
-- Check the `generation_urls` output for detailed logs on the CodeForge platform
-- Common causes: invalid spec, broken SDK configuration, or a temporary platform issue
-- Set `fail_on_error: false` if you want the workflow to continue regardless
+- Double-check the `spec_id` value — it should match the document instance ID
+  shown in the CodeForge platform URL
+- Confirm the API token has access to this document instance
 
 ## Release Process
 

action.yml

@@ -3,33 +3,17 @@ description: 'Automatically generate and publish SDKs when your OpenAPI spec cha
 
 inputs:
   spec_id:
-    description: 'CodeForge spec ID (find in platform UI)'
+    description: 'CodeForge document instance ID (find in platform UI)'
     required: true
   api_token:
     description: 'CodeForge API token (generate in Account Settings)'
     required: true
-  spec_path:
-    description: 'Path to OpenAPI spec file in repo (e.g., api/openapi.yaml)'
-    required: true
-  sdk_ids:
-    description: 'Comma-separated SDK IDs to regenerate (optional, defaults to all)'
-    required: false
-  wait_for_completion:
-    description: 'Wait for generation to complete (default: true)'
-    required: false
-    default: 'true'
-  fail_on_error:
-    description: 'Fail workflow if generation fails (default: true)'
-    required: false
-    default: 'true'
 
 outputs:
-  status:
-    description: 'Generation status: success | failed | in_progress'
-  generation_urls:
-    description: 'Comma-separated URLs to view logs on CodeForge'
-  published_packages:
-    description: 'JSON array of published package info'
+  checks_started:
+    description: 'Number of generation checks that were started'
+  logs_url:
+    description: 'URL to view generation logs on CodeForge'
 
 runs:
   using: 'node20'

package.json

@@ -1,20 +1,20 @@
 {
-  "name": "codegen-action",
-  "version": "1.0.0",
-  "description": "GitHub Action to trigger CodeForge SDK generation when OpenAPI specs change",
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "ncc build src/main.ts -o dist --source-map --minify",
-    "test": "jest"
-  },
-  "dependencies": {
-    "@actions/core": "^1.10.0"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "@vercel/ncc": "^0.38.0",
-    "jest": "^29.0.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.0.0"
-  }
+	"name": "codegen-action",
+	"version": "1.1.0",
+	"description": "GitHub Action to trigger CodeForge SDK generation when OpenAPI specs change",
+	"main": "dist/index.js",
+	"scripts": {
+		"build": "ncc build src/main.ts -o dist --source-map --minify",
+		"test": "jest"
+	},
+	"dependencies": {
+		"@actions/core": "^1.10.0"
+	},
+	"devDependencies": {
+		"@types/node": "^20.0.0",
+		"@vercel/ncc": "^0.38.0",
+		"jest": "^29.0.0",
+		"ts-jest": "^29.0.0",
+		"typescript": "^5.0.0"
+	}
 }