Skip to content

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

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 workflow fails before executing any jobs: its old entry point no longer supports workflow_call. 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. Allow the GrumPHP shim installed by current DevTools; other Composer constraints and allowlist entries remain unchanged.

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.

@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:29:28.138224Z 6859745 PR opened
🔒 Security Review ✅ Completed 2026-10-13T07:34:41.179586Z 6859745 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: fe48e968-5e51-4dbc-ae4f-c16907483a87
📥 Commits

Reviewing files that changed from the base of the PR and between 1ed6881 and 6859745.

📒 Files selected for processing (4)
  • .github/wiki
  • .github/workflows/wiki.yml
  • .gitmodules
  • composer.json
💤 Files with no reviewable changes (2)
  • .github/wiki
  • .gitmodules

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

  • Chores
    • Updated the wiki publishing workflow to run on pushes to the main branch, pull requests, and manual requests. Its permissions are more limited, and it uses a fixed version of the shared workflow.
    • Updated Composer configuration to allow an additional development tooling plugin.
    • Removed the repository’s wiki subproject reference.

The wiki workflow now runs on pull requests, pushes to main, and manual dispatch. It uses a pinned reusable workflow and no longer includes the wiki submodule. Composer allows the phpro/grumphp-shim plugin.

Changes: Wiki workflow

Layer / File(s) Summary
Workflow triggers and submodule removal
.github/workflows/wiki.yml, .github/wiki, .gitmodules
The workflow adds a pull request trigger and pins its reusable workflow to a commit. It removes pages: write, id-token: write, and inherited secrets. The wiki submodule reference is removed.

Composer plugin configuration

Layer / File(s) Summary
Allow the GrumPHP shim plugin
composer.json
Composer’s allowed plugins list now includes phpro/grumphp-shim.

Priority: ⬇️ Low

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

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 68597

No actionable issue is established before merge. Wiki publication on main still needs the planned post-merge verification.

Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
Description check Passed The description clearly explains the workflow replacement, submodule removal, permission changes, pinned dependency, and validation results. It directly matches the changeset.
Title check Passed The title clearly summarizes the primary change: restoring Wiki publication without the 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 workflow’s track,
Pull requests join the push dispatch.
The wiki submodule hops away,
A pinned workflow takes its place.
The shim plugin joins Composer’s list.

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

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