Skip to content

Prepare v3 documentation and consistent CI publication - #15

Merged
carldebilly merged 4 commits into
masterfrom
dev/cdb/v3-release-preparation
Sep 13, 2026
Merged

carldebilly merged 4 commits into
masterfrom
dev/cdb/v3-release-preparation

Conversation

@carldebilly

Copy link
Copy Markdown
Member

Summary

Prepare the documentation and publication workflow for a future 3.0 stable release. This PR does not bump the version, create a release branch, or publish a stable release.

  • Explain CLI, interactive REPL and MCP usage, the v2 migration, browser/storage prerequisites, and installation from complete archives. Correct the C# options examples and document manual portable MCP configuration.
  • Keep the remaining limitations in MCP: list_properties / list_units / list_leases / list_transactions all return generic invocation errors against a live tenant #12 visible without changing API behavior. The embedded MCP guide now describes a null unit price as unknown rather than zero.
  • Make CI build from an immutable commit, share the resolved version, validate package versions, and target the built SHA when creating a release tag. NuGet publication now waits for binary packaging and smoke checks.

Release workflow change

Release branches must contain a reviewed stable version before they are pushed. CI no longer changes version.json or pushes a versioning commit during the build, preventing packages and binaries from being built from different commits.

Existing publishing policy is retained: pushes to master publish prereleases; pushes to release/** publish stable releases. Pull requests do not publish. A stable release-branch push remains a separate, explicit decision.

Validation

  • Release solution build: zero warnings and errors.
  • Non-API tests: 71 passed, none failed or skipped.
  • All 19 C# documentation snippets compiled with contextual imports/variables against both .NET 8 and .NET 10.
  • Local Markdown links, anchors and fences checked; packaged NuGet READMEs match their source files.
  • actionlint and PowerShell parsing passed. Local checks exercised the release-version guard, publication dependencies, shared version, pinned checkouts/tag target, and acceptance/rejection of matching/mismatched package versions.
  • Portable and Windows R2R publications completed. Both ZIPs started after extraction outside the repository; MCP Inspector listed the data tools from the extracted Windows executable without API calls.

The authenticated run returned 80 passes and 3 failures with TenantCloud's Too Many Attempts response. API limitations and their fixes remain outside this PR. No fresh macOS execution is claimed; the release checklist links the existing macOS validation separately. The GitHub-hosted workflow still needs to run on this PR.

@carldebilly

Copy link
Copy Markdown
Member Author

@codex a review please.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 13, 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-13T14:15:27.472821Z b7bdd4f 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 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: f95ee60a0b

ℹ️ 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".

@autocarl autocarl 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.

Review summary

Changes requested for three release-readiness issues. Two additional findings are inline below; the existing tc://guide indentation finding is also confirmed by a live MCP resources/read probe: price is returned with one leading tab and renders as a child of description.

I otherwise verified the immutable checkout/artifact path, the release-version guard, matching and mismatching package-version cases, the downloaded portable archive, NuGet README identity, C# usage examples on net8.0/net10.0, and the Release test suite (71 non-API passes; 12 credential-dependent skips). actionlint 1.7.12 is clean and the hosted checks are green for the reviewed head.

Comment thread .github/workflows/ci.yml Resolved
Comment thread docs/mcp-server.md Resolved

@autocarl autocarl 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.

Supplemental review findings

An independent CI/security and MCP-contract pass found three additional issues, each reproduced against this head. I also expanded the existing tc://guide thread separately with the confirmed wire-contract mismatch.

Comment thread .github/workflows/ci.yml Resolved
Comment thread .github/workflows/ci.yml Resolved
Comment thread docs/mcp-server.md Resolved
@carldebilly

Copy link
Copy Markdown
Member Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🚀

Reviewed commit: b7bdd4f322

ℹ️ 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".

@carldebilly
carldebilly merged commit 6cdce8b into master Sep 13, 2026
7 checks passed
@carldebilly
carldebilly deleted the dev/cdb/v3-release-preparation branch September 13, 2026 17:05
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