Skip to content

IFC-2338: Documentation final updates and towncrier for webhook headers#8604

Open
polmichel wants to merge 29 commits intopmi-20260227-webhooks-ifc-2272from
pmi-20260314-webhooks-final-steps
Open

IFC-2338: Documentation final updates and towncrier for webhook headers#8604
polmichel wants to merge 29 commits intopmi-20260227-webhooks-ifc-2272from
pmi-20260314-webhooks-final-steps

Conversation

@polmichel
Copy link
Contributor

@polmichel polmichel commented Mar 14, 2026

Why

Final documentation pass and changelog entry for the webhook custom headers feature (INFP-445 / IFC-2272).

Closes IFC-2338

What changed

  • Updated internal developer documentation (dev/knowledge/) with schema-definitions, code-generation, testing, and webhooks knowledge
  • Updated external documentation (docs/docs/topics/webhooks.mdx) with user-facing webhook headers guide
  • Updated spec-kit specification after CorePasswordKeyValue removal
  • Added towncrier changelog fragment for the feature

Based on

This PR is the final step in the webhook custom headers feature chain, targeting pmi-20260227-webhooks-ifc-2272.

All based PRs in this chain:

  1. #8590 — IFC-2303: CoreKeyValue schema definitions for webhook custom headers
  2. #8597 — IFC-2304: Runtime resolution of webhook custom headers
  3. #8602 — IFC-2334: Webhook cache invalidation on KeyValue changes
  4. #8603 — IFC-2337: Invalidate webhook cache on reconcile_all

How to review

Documentation-only changes plus a towncrier fragment. No behavioral changes.
The first commit to review in this PR is updating internal-documentation

How to test

# Verify docs build
cd docs && npm run build

Checklist

  • Tests added/updated
  • Changelog entry added (uv run towncrier create ...)
  • External docs updated (if user-facing or ops-facing change)
  • Internal .md docs updated (internal knowledge and AI code tools knowledge)

polmichel and others added 28 commits March 13, 2026 10:00
Introduces CoreKeyValue generic with CoreStaticKeyValue, CorePasswordKeyValue,
and CoreEnvironmentVariableKeyValue node types. Adds headers relationship to
CoreWebhook generic. Registers all new schemas in core_models_mixed.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ern equivalents

Use human_friendly_id and display_label (Jinja2 template) instead of the
deprecated default_filter and display_labels on all CoreKeyValue schemas.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 14, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (4)
  • main
  • stable
  • develop
  • release-.*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 269c132d-528d-4406-b1a0-e2f4a1c802a0

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added the type/documentation Improvements or additions to documentation label Mar 14, 2026
@github-actions github-actions bot added group/backend Issue related to the backend (API Server, Git Agent) group/frontend Issue related to the frontend (React) labels Mar 14, 2026
@codspeed-hq
Copy link

codspeed-hq bot commented Mar 14, 2026

Merging this PR will not alter performance

✅ 12 untouched benchmarks


Comparing pmi-20260314-webhooks-final-steps (8592e9f) with stable (c396f66)1

Open in CodSpeed

Footnotes

  1. No successful run was found on pmi-20260227-webhooks-ifc-2272 (44c9479) during the generation of this report, so stable (c396f66) was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@polmichel polmichel marked this pull request as ready for review March 14, 2026 14:16
@polmichel polmichel requested review from a team as code owners March 14, 2026 14:16
Add 3 serial E2E tests covering the full lifecycle of webhook custom headers:
create a StaticKeyValue, associate it as a header on a webhook, then dissociate it.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

group/backend Issue related to the backend (API Server, Git Agent) group/frontend Issue related to the frontend (React) type/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant