Skip to content

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

Open
coisa wants to merge 1 commit into
mainfrom
codex/wiki-without-submodule
Open

coisa wants to merge 1 commit 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 a286666dfca2300fffca1ab0d3517b6294ec2c4e, 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.

@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-13T07:30:51.673858Z ddaa82d PR opened
🔒 Security Review ✅ Completed 2026-10-13T07:30:54.238838Z ddaa82d PR opened
ℹ️ 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: 67b70a2e-2140-48ca-85bf-b35aa0ea8be2
📥 Commits

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

📒 Files selected for processing (5)
  • .github/wiki
  • .github/workflows/wiki-maintenance.yml
  • .github/workflows/wiki.yml
  • .gitmodules
  • CHANGELOG.md
💤 Files with no reviewable changes (3)
  • .github/wiki
  • .gitmodules
  • .github/workflows/wiki-maintenance.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 now published directly by an automated workflow, rather than being tracked as a Git submodule.
    • Wiki publishing runs when changes are pushed to the main branch, when a pull request is opened or updated, and when manually started.

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

Suggested reviewers: php-fast-forward

Merge Risk: ⚪ Minimal · up to ddaa8

Non-main manual runs do not publish to the Wiki, and the submodule and maintenance-workflow removals match the direct-publishing change. No material merge risk is established.

Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
Description check Passed The description clearly explains the direct Wiki publication workflow, submodule removal, legacy workflow removal, validation, and main-only publication.
Title check Passed The title clearly and concisely identifies the main change: restoring Wiki publication without a submodule.
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.
✨ 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 checks the Wiki flow,
A push or pull request starts the show.
The submodule hops out of sight,
Direct pages land by workflow light.
One carrot saved for publish night.

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

@github-actions

Copy link
Copy Markdown
Contributor

This branch has not been deployed

No deployments
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