Skip to content

Validate DocFX API output in C# workflow - #133

Merged
konard merged 5 commits into
mainfrom
issue-36-682afee2
Sep 24, 2026
Merged

konard merged 5 commits into
mainfrom
issue-36-682afee2

Conversation

@konard

@konard konard commented Sep 10, 2025 •

Copy link
Copy Markdown
Member

Summary

  • Merge the current main branch and resolve the DocFX configuration conflicts using its project-based metadata and current table of contents.
  • Keep DocFX warning-strict (--warningsAsErrors) and verify the generated home page, namespace page, README-linked interface page, and cross-reference map before upload and after artifact download.
  • Add regression tests for incomplete documentation output and for the workflow checks that run the validator.

Reproduction and regression coverage

Before this change, the workflow accepted a documentation artifact if _site/index.html existed, even when the API pages were missing. The new validate-csharp-docs.test.mjs checks a complete site and separately removes each required file to verify that validation fails. The workflow policy test checks that both the build and publication jobs invoke the validator and that DocFX warnings remain errors.

Verification

  • node --test .github/scripts/*.test.mjs — 37 passed.
  • DOTNET_ROLL_FORWARD=Major .github/scripts/validate-csharp-package.sh — 2 C# tests passed, strict build with 0 warnings and 0 errors. The local machine has .NET 10 only; CI installs .NET 8.
  • DocFX 2.80.1: docfx docfx.json --warningsAsErrors — 0 warnings, 0 errors; generated output passed the new validator.
  • actionlint, bash -n .github/scripts/*.sh, and git diff --check origin/main...HEAD — passed.
  • C# PR run 36053747313 — all required jobs passed; build and DocFX each reported 0 warnings and 0 errors, with site validation passing before upload and after download.

CI review

The latest main C# run 35691769893 built DocFX with 0 warnings and 0 errors. Its release job failed because NuGet.org returned HTTP 403 for the repository NUGET_TOKEN; a maintainer must rotate or correct that secret. The PR workflow does not publish packages. An older C++ release run 35648595098 failed while installing the unavailable Ubuntu nuget package in the separate linksplatform/Workflows reusable workflow.

Fixes #36

Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #36
@konard konard self-assigned this Sep 10, 2025
konard and others added 2 commits September 10, 2025 18:45
- Update TargetFramework from netstandard2.0 to net8 to match project files
- Replace $REPOSITORY_NAME template variable with 'Interfaces'
- Configure proper file inclusion for README.md from parent directory
- Add DocFX configuration files (docfx.json, filter.yml, toc.yml)

Fixes #36

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@konard konard changed the title [WIP] Fix DocFX warnigns Fix DocFX warnings in documentation generation Sep 10, 2025
@konard
konard marked this pull request as ready for review September 10, 2025 15:52
@konard

konard commented Sep 24, 2026

Copy link
Copy Markdown
Member Author

We need to resolve conflicts, and double check we fix all CI/CD warnings, false positives, false negatives and errors.

@konard
konard marked this pull request as draft September 24, 2026 20:08
@konard

konard commented Sep 24, 2026

Copy link
Copy Markdown
Member Author

🤖 AI Work Session Started

Starting automated work session at 2026-09-24T20:08:05.807Z

The PR has been converted to draft mode while work is in progress.

This comment marks the beginning of an AI work session. Please wait for the session to finish, and provide your feedback.

Runtime: solve v2.32.0 · tool codex · model gpt-6-sol · task image konard/hive-mind-dind:2.32.0@sha256:f73befa87d04185dfba6329bbb9acc8b8b16f1bbb1b07d68d7b38d28df574020

@konard konard changed the title Fix DocFX warnings in documentation generation Validate DocFX API output in C# workflow Sep 24, 2026
@konard

konard commented Sep 24, 2026

Copy link
Copy Markdown
Member Author

CI review found two release failures that require repository/workflow maintainer action:

  • C# main run 35691769893: the downloaded log at lines 1361–1363 shows NuGet.org HTTP 403: The specified API key is invalid, has expired, or does not have permission to access the specified package. Please rotate or correct NUGET_TOKEN for Platform.Interfaces. The DocFX build in that same run reported 0 warnings and 0 errors (log lines 3336–3337).
  • C++ release run 35648595098: the log at lines 3310–3315 shows E: Package 'nuget' has no installation candidate. This repository delegates deployment to linksplatform/Workflows/.github/workflows/deploy-cpp.yml@main; that reusable workflow needs a supported package tooling path. The run also emits deprecation warnings from the shared release action.

PR #133 now resolves its merge conflict and validates complete DocFX output. Its pull-request checks do not publish packages.

@konard
konard marked this pull request as ready for review September 24, 2026 20:20
@konard

konard commented Sep 24, 2026

Copy link
Copy Markdown
Member Author

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

💰 Cost estimation:

  • Model: GPT-6 Sol
  • Provider: OpenAI
  • Public pricing estimate: $2.437831

📊 Context and tokens usage:

  • 122.1K / 200K (61%) input tokens, 19.8K / 128K (15%) output tokens

Total: (122.1K + 4.1M cached) input tokens, 19.8K output tokens, $2.437831 cost

🤖 Models used:

  • Tool: OpenAI Codex
  • Requested: gpt-6-sol
  • Thinking level: xhigh (~31999 tokens)
  • Model: GPT-6 Sol (gpt-6-sol)

📎 Log file uploaded as Gist (2815KB)


Now working session is ended, feel free to review and add any feedback on the solution draft.

@konard
konard merged commit 2c3679a into main Sep 24, 2026
16 checks passed
@konard

konard commented Sep 24, 2026

Copy link
Copy Markdown
Member Author

🎉 Auto-merged

This pull request has been automatically merged by hive-mind.

  • All CI checks have passed

Auto-merged by hive-mind with --auto-merge flag

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.

Fix DocFX warnigns

1 participant