Skip to content

docs(releases): document SDK compatibility and recovery - #185

Merged
swkeever merged 2 commits into
mainfrom
skeever/sdk-release-guide
Sep 19, 2026
Merged

swkeever merged 2 commits into
mainfrom
skeever/sdk-release-guide

Conversation

@swkeever

Copy link
Copy Markdown
Collaborator

Users need a documented way to select a compatible runtime, pin an SDK, upgrade, and restore a tested dependency set. Add a public versions guide and link it from the language landing page. Add a separate maintainer checklist for exact artifacts, acceptance evidence, explicit publication authorization and recovery.

Documentation only; package versions, runtime code and workflows are unchanged. Registry-installed quickstarts have synthetic local HTTP evidence, which the guide distinguishes from live acceptance. A written rollback procedure is not a performed rollback.

Validation: native generation, lint, tests, build and package checks; public docs format and whitespace checks. Related: VOL-950.

@swkeever

Copy link
Copy Markdown
Collaborator Author

@codex review

Please run code and security reviews on 26e7d4bbe2f5c5a73c99d1ed3e7dd4ea5caccc67. Verify runtime/version statements against package metadata and workflows, safe dependency restoration, and the distinction between local package evidence, live acceptance and explicit release authorization. This is documentation only.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-19T23:04:23.905767Z 5a8111b Manual request
🔒 Security Review ✅ Completed 2026-09-19T23:05:38.596237Z 5a8111b Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Can't wait for the next one!

Reviewed commit: 26e7d4bbe2

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review · Automatically triggered

Security review completed. No security issues were found in this pull request.

Reviewed commit: 26e7d4bbe2

View security finding report

Only the user who started this review can view the report in Codex.

ℹ️ About Codex security reviews in GitHub

This is an experimental Codex feature. Security reviews are triggered when:

  • You comment "@codex security review"
  • A regular code review gets triggered (for example, "@codex review" or when a PR is opened), and you’re opted in so security review runs alongside code review

Once complete, Codex will leave suggestions, or a comment if no findings are found.

@swkeever

Copy link
Copy Markdown
Collaborator Author

@codex review

Please rerun code and security reviews on 5a8111be78b8b7eea1a3c9a1b4cd29f97bc0a51f. Applied the JavaScript review findings across all three guides: local artifact checks are candidate package-content evidence, not approval of the later release-workflow bytes; the docs explain the actual preserved-artifact publication path and its limits. Suspected vulnerabilities go to Kong’s private reporting channel, not public issues. Ruby also distinguishes its preserved-gem manual recovery path. Documentation checks pass; no source/runtime/workflow changes.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Hooray!

Reviewed commit: 5a8111be78

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review · Automatically triggered

Security review completed. No security issues were found in this pull request.

Reviewed commit: 5a8111be78

View security finding report

Only the user who started this review can view the report in Codex.

ℹ️ About Codex security reviews in GitHub

This is an experimental Codex feature. Security reviews are triggered when:

  • You comment "@codex security review"
  • A regular code review gets triggered (for example, "@codex review" or when a PR is opened), and you’re opted in so security review runs alongside code review

Once complete, Codex will leave suggestions, or a comment if no findings are found.

@swkeever
swkeever marked this pull request as ready for review September 19, 2026 23:07
@swkeever
swkeever merged commit d18c389 into main Sep 19, 2026
6 checks passed
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