Update guide
Update the integration whenever an endpoint, input, output, product state, price, prompt rule, Relevance AI behavior, or source limitation changes.
One-change rule
A contract change must update every affected surface in the same pull request:
- canonical runtime/catalog or API contract;
authoring-manifest.json;- JSON schemas;
- runtime selection/normalization;
- fixtures and tests;
- system prompt;
- capability matrix;
- installation and everyday-use documentation;
- public case and public docs copy when claims change.
Do not update only the prose or only the Tool.
Endpoint change
- Confirm the new endpoint is canonical and deployed in the intended environment.
- Update the manifest and Tool API step.
- Check method, headers, body, status handling, redirects, and response size.
- Run all fixtures and contract tests.
- Publish a new internal Tool version; do not overwrite the last known-good version without a rollback target.
- Connect a test agent to the new version.
- Promote only after synthetic certification.
Price or sellability change
- Read the canonical pricing/catalog source.
- Update the manifest, price examples, fixture expectations, capability matrix, and public copy together.
- Verify the agent displays the new price before approval.
- Confirm conditioned or non-purchasable items show no sellable price.
- Never infer price from an old screenshot.
Input/output contract change
- Version the schema when compatibility requires it.
- Preserve old consumers or document the breaking migration.
- Update Tool inputs and normalization.
- Add fixtures for missing, invalid, and legacy fields.
- Verify no sensitive field is newly exposed.
Prompt change
Treat prompt changes as behavior changes. Test capability selection, price disclosure, approval, decision mapping, prohibited claims, and refusal paths. A shorter prompt is not an improvement if it removes a safety boundary.
Relevance AI UI or platform change
Use current official Relevance AI documentation. Record the review date in OFFICIAL-SUPPORT.md. If timeouts, retries, secret handling, response limits, import, or Marketplace rules remain undocumented, mark them NOT_DOCUMENTED; do not guess.
Release sequence
- Branch from current
main. - Make the smallest coherent change.
- Run
npm run demo:relevance-aiandnpm run test:relevance-aiplus affected checks. - Review links, JSON examples, product names, prices, and secrets.
- Open a pull request and wait for green checks.
- Merge through the normal repository policy.
- Publish a new internal Tool/agent version only when needed.
- Run safe synthetic workspace QA.
- Update observed evidence and public copy.
Never publish a higher state than the evidence proves.