Skip to content

fix(wiki): restore publication without a submodule - #11

Merged
coisa merged 2 commits into
mainfrom
codex/wiki-without-submodule
Oct 14, 2026
Merged

coisa merged 2 commits into
mainfrom
codex/wiki-without-submodule

Conversation

@coisa

@coisa coisa commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

The current Wiki flow still depends on a tracked Wiki submodule and preview-maintenance writers. Adopt the direct-publication workflow derived from php-fast-forward/container#15 and shared in php-fast-forward/dev-tools#366.

Generate API Markdown with read-only credentials on PRs; only main can publish through an isolated checkout of the separate Wiki repository. Remove the .github/wiki gitlink and its matching .gitmodules entry, preserving the remote Wiki/history. Retire the automatic legacy maintenance wrapper so it cannot recreate pointer-based behavior.

The caller is pinned to c44339acd9b09b1a7f2249cceb8928e5e93cf42b, the reviewed implementation commit of dev-tools#366. This makes the generation checks executable before that shared PR merges; merge the shared change first so normal dev-tools:sync also stops invoking wiki --init.

Validation: Composer validate --strict --no-plugins, actionlint and git diff --check passed. The shared actual publisher passed 54 offline assertions and DevTools passed 717 tests / 2,201 assertions with 91.83% coverage. GitHub checks exercise this repository's real Markdown generation. Publication is main-only and remains to be verified after merge.

The required full local composer dev-tools command was run: tests (2 / 78 assertions), Rector, ECS and report generation pass, but it flags existing PHPDoc formatting in unchanged source. This workflow-only PR does not reformat library code.

Follow-up: use the isolated pinned renderer, with no Composer manifest changes in this PR. The shared release flow now skips legacy pointer refresh when the Wiki gitlink is absent.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 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-10-14T19:16:27.647637Z 832c2ef Manual request
🔒 Security Review ✅ Completed 2026-10-14T19:15:46.677661Z 832c2ef 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.

@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 0acd22b6-f216-4f23-94d0-ec7181543e9f
📥 Commits

Reviewing files that changed from the base of the PR and between ddaa82d and 832c2ef.

📒 Files selected for processing: 1
  • .github/workflows/wiki.yml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Changes
    • Generated Wiki pages are published directly, rather than being tracked as a Git submodule.
    • Wiki publishing runs on pushes to the main branch, pull requests, and manual starts.

The Wiki workflow now publishes through a pinned reusable workflow on pushes to main, pull requests, and manual dispatch. The Wiki submodule reference and its maintenance workflow were removed.

Changes: Wiki Publishing

Layer / File(s) Summary
Direct publication workflow
.github/workflows/wiki.yml, .github/workflows/wiki-maintenance.yml
The Wiki workflow now runs on pushes to main, pull requests, and manual dispatch. It grants contents: write and calls the pinned wiki-direct.yml workflow. The maintenance workflow was removed.
Remove Wiki submodule tracking
.github/wiki, .gitmodules, CHANGELOG.md
The Wiki submodule reference and its .gitmodules entry were removed. The changelog describes direct publication without submodule tracking.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 832c2

Wiki generation now runs for pull requests, while publication is restricted to main. Removing the submodule leaves no local build or maintenance workflow dependent on it, so no actionable merge risk remains.

Pre-merge checks: Passed 5
Passed Passed checks: 5 passed
Check name Status Explanation
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Title check Passed The title clearly summarizes the main change: restoring Wiki publication without the tracked submodule.
Description check Passed The description directly explains the workflow changes, submodule removal, direct publication model, validation results, and follow-up requirements.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit watched the Wiki flow,
As main and pull requests now go.
The submodule hopped away,
Direct pages publish today.
I nibble greens and cheer the show.

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

@github-actions

Copy link
Copy Markdown
Contributor

@coisa

coisa commented Oct 14, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

@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: 832c2ef5a3

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.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep them coming!

Reviewed commit: 832c2ef5a3

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

@coisa
coisa merged commit c906e90 into main Oct 14, 2026
35 checks passed
@coisa
coisa deleted the codex/wiki-without-submodule branch October 14, 2026 19:36
github-actions Bot added a commit that referenced this pull request Oct 14, 2026
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