Skip to content

docs: add custom auth contract review guidance#48

Merged
TheRealAgentK merged 2 commits into
masterfrom
docs/custom-auth-review-guidance
Jun 23, 2026
Merged

docs: add custom auth contract review guidance#48
TheRealAgentK merged 2 commits into
masterfrom
docs/custom-auth-review-guidance

Conversation

@TheRealAgentK

@TheRealAgentK TheRealAgentK commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Summary

Updates the source reviewing-integration-prs skill in the SDK repo with custom-auth contract review guidance.

Changes

Adds a custom-auth review checklist that asks reviewers to verify:

  • auth.fields describes the same auth object shape the SDK/platform passes to context.auth at execution time.
  • auth.fields.required, when present, matches that runtime auth shape and covers credentials that must be present before handlers run.
  • Non-empty required arrays are valid when they match the SDK/platform contract.
  • auth.fields.properties declares every credential field read from context.auth, including nested credential fields if the runtime contract is wrapped.
  • Action code does not read undeclared credential keys.
  • At least one unit test exercises integration.execute_action(...) with the expected SDK/platform auth shape.
  • Tests cover missing required credentials when the config uses auth.fields.required.
  • Live integration tests are not treated as CI coverage unless CI explicitly ran them.

Also adds the review prompt: “Does this PR test the same SDK/platform contract that production will use?”

Validation

  • git diff --check

No SDK source/API files were changed, so API docs regeneration and SDK test-suite execution were not needed.

@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown

Coverage — 9f7e817 (docs: clarify custom auth required review) by @TheRealAgentK

Total coverage: 100%

File Stmts Miss Cover Missing
src/autohive_integrations_sdk/__init__.py 2 0 100%
src/autohive_integrations_sdk/integration.py 358 0 100%

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4d66314ee2

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread skills/reviewing-integration-prs/SKILL.md Outdated
@TheRealAgentK TheRealAgentK changed the title docs: add custom auth review guidance docs: add custom auth contract review guidance Jun 23, 2026
@TheRealAgentK TheRealAgentK merged commit a579436 into master Jun 23, 2026
1 check passed
@TheRealAgentK TheRealAgentK deleted the docs/custom-auth-review-guidance branch June 23, 2026 12:49
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.

2 participants