Skip to content

GH#876: Better idiot-resistance for wrong-ZIP downloads#878

Merged
superdav42 merged 1 commit intomainfrom
feature/auto-20260415-151236-gh876
Apr 15, 2026
Merged

GH#876: Better idiot-resistance for wrong-ZIP downloads#878
superdav42 merged 1 commit intomainfrom
feature/auto-20260415-151236-gh876

Conversation

@superdav42
Copy link
Copy Markdown
Collaborator

@superdav42 superdav42 commented Apr 15, 2026

Summary

Resolves #876

Users who click GitHub's green "Code → Download ZIP" button get the raw source archive (no compiled vendor dependencies) and hit cryptic errors. Two improvements:

README.md

Added a prominent blockquote callout directly above the Installation section:

Important: Do not use GitHub's green "Code → Download ZIP" button on this page. That archive is the raw source code and is missing the compiled dependencies — installing it will produce errors such as Failed opening required .../vendor/autoload_packages.php. Always download from the Releases page instead.

ultimate-multisite.php — incomplete-install admin notice

  • Fixed broken URL: old link pointed to superdav42/wp-multisite-waas (the previous repo) — updated to Ultimate-Multisite/ultimate-multisite.
  • Added direct Releases page link: non-developers now see an actionable link to the Releases page, not just a developer docs link.
  • Added bold heading ("Ultimate Multisite: Incomplete installation detected.") for immediate visual scanability in the network admin notice area.
  • Improved error log message: describes the likely cause (source ZIP vs release ZIP) instead of generic "incomplete".

Runtime Testing

Risk: Low — documentation change + error-message text/URL update. No logic changes. Verified:

  • git diff shows only the two expected files changed.
  • PHPCS (--standard=WordPress): violation count reduced 52 → 48 (net improvement; pre-existing project config has broken sniff references unrelated to this PR).

aidevops.sh v3.8.43 plugin for OpenCode v1.4.6 with claude-sonnet-4-6 spent 5m and 16,539 tokens on this as a headless worker.

Summary by CodeRabbit

  • Documentation

    • Updated installation instructions to direct users to download from the Releases page, preventing vendor file errors.
  • Bug Fixes

    • Enhanced error detection and admin notices for incomplete installations with clear guidance on proper setup methods.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 15, 2026

Warning

Rate limit exceeded

@superdav42 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 52 minutes and 45 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 52 minutes and 45 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3ab8d6a4-317f-4fee-b21d-f9fc555ad5a3

📥 Commits

Reviewing files that changed from the base of the PR and between 8699f08 and e16e2fd.

📒 Files selected for processing (2)
  • README.md
  • ultimate-multisite.php
📝 Walkthrough

Walkthrough

Both README.md and ultimate-multisite.php have been updated to address incomplete plugin installations caused by users downloading the source ZIP from GitHub's Code button instead of using the Releases page. The README now includes installation guidance, while the plugin's error notice has been enhanced with clearer messaging and actionable links.

Changes

Cohort / File(s) Summary
Installation Guidance Updates
README.md, ultimate-multisite.php
Added installation warning in README directing users to download from the Releases page instead of the Code ZIP button. Enhanced the plugin's network admin notice to display "Incomplete installation detected" as a heading, updated the error message to reference missing vendor files, and replaced the single setup link with two separate links: one to the Releases page and one to developer setup documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A ZIP from the Code button, oh what a plight!
No vendors included, the autoload won't light,
But now there's a warning, so shiny and clear:
The Releases page beckons, "Download from here!"
Your knee will stop aching, your plugins will flow! 🎯

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main objective: improving guidance to prevent incorrect installation from GitHub's ZIP download instead of releases.
Linked Issues check ✅ Passed The PR fully addresses issue #876 by adding README guidance and improved admin notices directing users to the Releases page instead of GitHub's source ZIP.
Out of Scope Changes check ✅ Passed All changes (README documentation update and admin notice improvements) are directly aligned with resolving issue #876 and preventing incorrect source ZIP downloads.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/auto-20260415-151236-gh876

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

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

@github-actions
Copy link
Copy Markdown

🔨 Build Complete - Ready for Testing!

📦 Download Build Artifact (Recommended)

Download the zip build, upload to WordPress and test:

🌐 Test in WordPress Playground (Very Experimental)

Click the link below to instantly test this PR in your browser - no installation needed!
Playground support for multisite is very limitied, hopefully it will get better in the future.

🚀 Launch in Playground

Login credentials: admin / password

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
README.md (1)

50-50: Standardize the Releases URL owner slug across docs and runtime notices.

Line 50 uses Multisite-Ultimate, while the admin notice uses Ultimate-Multisite (Line 108 in ultimate-multisite.php). Please pick one canonical URL to avoid redirect dependence and future link drift.

Proposed doc tweak
-> **Important:** Do not use GitHub's green **"Code → Download ZIP"** button on this page. That archive is the raw source code and is missing the compiled dependencies — installing it will produce errors such as `Failed opening required .../vendor/autoload_packages.php`. Always download from the [**Releases page**](https://github.com/Multisite-Ultimate/ultimate-multisite/releases) instead.
+> **Important:** Do not use GitHub's green **"Code → Download ZIP"** button on this page. That archive is the raw source code and is missing the compiled dependencies — installing it will produce errors such as `Failed opening required .../vendor/autoload_packages.php`. Always download from the [**Releases page**](https://github.com/Ultimate-Multisite/ultimate-multisite/releases) instead.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 50, The README and the admin notice in
ultimate-multisite.php use inconsistent GitHub owner slugs ("Multisite-Ultimate"
vs "Ultimate-Multisite"); choose one canonical slug and update all occurrences
to match it (update the README.md line containing the Releases page URL and the
admin notice string in ultimate-multisite.php), ensuring the Releases URL is
identical in both places to avoid redirects and future link drift.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 50: The README and the admin notice in ultimate-multisite.php use
inconsistent GitHub owner slugs ("Multisite-Ultimate" vs "Ultimate-Multisite");
choose one canonical slug and update all occurrences to match it (update the
README.md line containing the Releases page URL and the admin notice string in
ultimate-multisite.php), ensuring the Releases URL is identical in both places
to avoid redirects and future link drift.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fea5b70c-fa02-4a08-aa7b-2dc16bbacd78

📥 Commits

Reviewing files that changed from the base of the PR and between adcf871 and 8699f08.

📒 Files selected for processing (2)
  • README.md
  • ultimate-multisite.php

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 15, 2026

Performance Test Results

Performance test results for 0be55b9 are in 🛎️!

Note: the numbers in parentheses show the difference to the previous (baseline) test run. Differences below 2% or 0.5 in absolute values are not shown.

URL: /

Run DB Queries Memory Before Template Template WP Total LCP TTFB LCP - TTFB
0 40 (-1 / -3% ) 37.80 MB 709.00 ms (-16.00 ms / -2% ) 125.00 ms (+10.50 ms / +8% ) 868.50 ms 1636.00 ms 1570.20 ms 68.90 ms (-2.10 ms / -3% )
1 56 49.03 MB 741.00 ms 112.50 ms 852.50 ms 1626.00 ms (-38.00 ms / -2% ) 1563.55 ms (-37.45 ms / -2% ) 64.25 ms

- README: add prominent callout warning against the GitHub 'Code > Download ZIP'
  button; directs users to the Releases page instead.
- Main plugin file: fix broken link in incomplete-install admin notice (was pointing
  at the old superdav42/wp-multisite-waas repo); update error messages to mention
  the Releases page and include a direct link to it alongside the developer docs;
  add a bold heading to the notice for immediate visual scanability.
@superdav42 superdav42 force-pushed the feature/auto-20260415-151236-gh876 branch from 8699f08 to e16e2fd Compare April 15, 2026 21:25
@superdav42 superdav42 merged commit 0be55b9 into main Apr 15, 2026
1 check passed
@superdav42
Copy link
Copy Markdown
Collaborator Author

Completed via PR #878.

  • Attempts: 1
  • Duration: ~14 min (21:12Z dispatch → 21:26Z merge)

aidevops.sh v3.8.43 plugin for OpenCode v1.4.6 with claude-sonnet-4-6 spent 31m and 6,832 tokens on this as a headless worker. Solved in 8m.

@github-actions
Copy link
Copy Markdown

🔨 Build Complete - Ready for Testing!

📦 Download Build Artifact (Recommended)

Download the zip build, upload to WordPress and test:

🌐 Test in WordPress Playground (Very Experimental)

Click the link below to instantly test this PR in your browser - no installation needed!
Playground support for multisite is very limitied, hopefully it will get better in the future.

🚀 Launch in Playground

Login credentials: admin / password

@superdav42
Copy link
Copy Markdown
Collaborator Author

Merge Summary

PR #878 merged (squash) — resolves #876.

Changes delivered

README.md — Added a prominent blockquote callout at the top of the Installation section:

Do not use GitHub's green "Code → Download ZIP" button. That archive is the raw source code, missing compiled dependencies. Always download from the Releases page.

ultimate-multisite.php — Improved incomplete-install admin notice:

  • Fixed stale link (was superdav42/wp-multisite-waas, now Ultimate-Multisite/ultimate-multisite).
  • Added a direct link to the Releases page so non-developers see an immediately actionable path.
  • Added bold heading for visual scanability in the network admin notice area.
  • Improved error log message to describe the root cause (source ZIP vs release ZIP).

Verification

  • All CI checks green: PHP Lint, Code Quality, PHP 8.2–8.5, Build Plugin, WP Performance Metrics, Cypress (8.1 + 8.2), CodeRabbit.
  • PHPCS violation count: 52 → 48 (net improvement vs baseline).

aidevops.sh v3.8.43 plugin for OpenCode v1.4.6 with claude-sonnet-4-6 Solved in 1h 9m.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Better Idiot-Resistance

1 participant