Skip to content

docs: document generator_command inputs and fix README newline rendering#4

Merged
infracore merged 3 commits intomainfrom
docs/generator-inputs-readme
Apr 8, 2026
Merged

docs: document generator_command inputs and fix README newline rendering#4
infracore merged 3 commits intomainfrom
docs/generator-inputs-readme

Conversation

@infracore
Copy link
Copy Markdown
Member

Summary

Two related docs fixes, one commit each:

  1. Restore README newline rendering — regression from 0ae02e8 (the v1.9.0 JSON Schema merge). The committed README contained literal \n escape sequences instead of real newlines, so the entire file rendered as a single unreadable paragraph on github.com and in the Marketplace listing. Commit 1 just decodes \n and \t back to real characters — no content changes.

  2. Document generator_command and generator_artifact — both inputs shipped in v1.9.0 and are present in action.yml, but were never added to the README Inputs table. While fixing the rendering I also added rows for fail_on_breaking and webhook_url (same situation). Plus a new "Generator drift detection" section with a minimal YAML example and notes on supported generators (Zod → zodToJsonSchema, protobuf, TypeBox).

Reported by @skokaina on agents-oss/agentspec#39 — they went looking for generator_command in the README and found nothing.

Test plan

  • README renders correctly locally (579 → 634 lines, zero literal \n remaining)
  • Two clean commits — reviewers can scrutinize the docs additions separately from the bulk decode
  • No changes to action.yml, no changes to code, no tests affected
  • Verify rendered README on github.com after merge
  • Verify Marketplace listing picks up the fix

🤖 Generated with Claude Code

infracore and others added 3 commits April 8, 2026 09:59
Regression from 0ae02e8 (JSON Schema feature merge) — the committed
README contained literal backslash-n escape sequences instead of real
newlines, so the entire file rendered as one giant paragraph on GitHub
and in the Marketplace listing.

Decodes \n and \t back to real characters. No content changes.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Adds rows to the Inputs table for generator_command, generator_artifact,
fail_on_breaking, and webhook_url (all shipped in v1.9.0 but never
documented in the README). Adds a new "Generator drift detection"
section with a minimal YAML example and notes on supported generators
(Zod/zodToJsonSchema, protobuf, TypeBox).

Reported by @skokaina in agents-oss/agentspec#39.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The self-test jobs run delimit-action on fixtures and the action
attempts to post a PR comment. Without an explicit permissions block,
GITHUB_TOKEN defaults to read-only under the current org settings, so
the comment POST 403s and the job fails with "Resource not accessible
by integration".

Adds the minimum scopes each job needs: contents:read + pull-requests:write.
Root-cause fix, not a workaround.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

🛡️ Breaking API Changes Detected

🔴 5 breaking changes · Semver: MAJOR · Next: 2.0.0

Count
Total changes 5
Breaking 5
Additive 0
Warnings 1

Breaking Changes

Severity Change Location
🔴 Critical Endpoint /users/{id}/profile cannot be removed. Deprecate it first. /users/{id}/profile
🟠 High Cannot add required parameter org_id to /users:GET /users:GET
🟡 Warning Type changed from string to integer at /users/{id}:GET /users/{id}:GET
⚠️ Policy warnings (1)
  • 🟡 /users/{id}:GET — Type changed from string to integer at /users/{id}:GET
📋 Migration guide

Migration Guide: User Service (1.0.0 -> 2.0.0)

This release contains 4 breaking change(s).
Follow the steps below to update your integration.

Step 1: Endpoint Removed

Change: Endpoint removed: /users/{id}/profile
Location: /users/{id}/profile

Action: Update all clients to stop calling this endpoint. If you control the consumers, search for references and remove them. Consider using the new endpoint (if applicable) as a replacement.

Step 2: Type Changed

Change: Parameter type changed: id from string to integer
Location: /users/{id}:GET

Action: Update serialization/deserialization logic for the new type. Check all type assertions, validators, and database column types.

Step 3: Required Param Added

Change: Required parameter added: org_id to /users:GET
Location: /users:GET

Action: All existing requests must now include this parameter. Update every call site to pass the new required value.

Step 4: Enum Value Removed

Change: Enum value 'guest' removed at #/components/schemas/User.role
Location: #/components/schemas/User.role

Action: Stop sending the removed enum value. Update any switch/case or if/else blocks that handle it.


After completing all steps, run your integration tests to verify.

Fix locally: npx delimit-cli lint

Governance Gates

Gate Status Chain
API Lint ❌ Fail lint → semver → gov_evaluate
Policy Compliance ❌ 3 violation(s) policy → evidence_collect
Security Audit ✅ Pass security_audit → evidence_collect
Deploy Readiness ⛔ Blocked deploy_plan → security_audit

🛡️ Enforcement chain: lint → semver → security_audit → gov_evaluate → evidence_collect → ledger
Deploy blocked until all gates pass. (advisory mode — CI will not fail)


Powered by Delimit · Docs · Install

@infracore infracore merged commit ddd7e84 into main Apr 8, 2026
5 checks passed
@infracore infracore deleted the docs/generator-inputs-readme branch April 8, 2026 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant