[AntonyGarand]

What & why

https://runelite.net/plugin-hub/show/flipping-utilities shows no description because the site fetches the README from the pinned commit (repos/Flipping-Utilities/rl-plugin/readme?ref=<pin>) and hub/publish snapshots strip README.md. This adds README.md to the publish snapshot so the next pin carries it, and fixes the README image URLs so they render on the hub page.

Testing

• No Java changes; ./gradlew clean build not affected (CI runs it).

• Dry run of the snapshot pipeline (Git Bash):

  • HUB_BRANCH=hub/readme-dryrun HUB_BASE=HEAD bash .github/scripts/publish-hub.sh seeded from the live Hub pin 2057976, reported "no plugin changes to snapshot" for the seed, and appended exactly one snapshot commit.
  • git diff --stat 2057976 hub/readme-dryrun → README.md | 324 +++++ — the only change; the packaged jar is unchanged.
  • Root listing of the dry-run snapshot: LICENSE README.md icon.png runelite-plugin.properties src.

• Image URL check: curl https://raw.githubusercontent.com/Flipping-Utilities/rl-plugin/master/images/flipping.png → 200 image/png (old blob/ URLs return HTML and render broken on the hub page, which does not rewrite absolute URLs).

• CI will additionally validate the new snapshot with the official Plugin Hub packager when it appends it to hub/publish.

• ./gradlew clean build green

Risk

High tier (CI/publish script), low blast radius: the packager ignores README.md (it is in plugin-hub-tooling's CORE_SOURCE_TEST), and the pin-to-pin review diff is a single added file. No code, config, or persistence changes.

How to revert

Revert this commit on master; the Publish Plugin Hub branch workflow re-runs and the snapshot returns to the previous tree (README drops out of later snapshots; hub/publish history is untouched, append-only). No Plugin Hub re-pin is needed unless the README-bearing pin was already submitted.

In-game verification

None — no in-game behavior.

Generated-by: GLM-5.3 (OpenCode)

Summary by CodeRabbit

• Documentation
  • Updated Plugin Hub publishing guidance to explain that the pinned README is used to display the plugin description on runelite.net; pins without a README show no description.
  • Updated README image links to use direct image URLs.
• New Features
  • Added author attribution to the Plugin Hub publishing configuration.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 6f62623f-78f3-4396-96e8-de87a8f2766c

📥 Commits

Reviewing files that changed from the base of the PR and between 7ccf052 and f8f26a2.

📒 Files selected for processing: 3

• .github/scripts/publish-hub.sh
• .github/workflows/publish-hub.yml
• README.md

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

📝 Walkthrough

The Plugin Hub publish snapshot now includes README.md. The README updates image links and explains how pinned README files supply the website description. The workflow summary adds an author field.

Changes: Plugin Hub publishing

Layer / File(s)	Summary
Update pin contents and publishing details .github/scripts/publish-hub.sh, .github/workflows/publish-hub.yml, README.md	The publish snapshot includes README.md, which runelite.net uses for the plugin description. The README’s image links now use raw URLs, and the workflow summary includes authors=AntonyGarand.

Priority: ➖ Normal

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

Change: Bug fix

Suggested reviewers: zumaad

Merge Risk: ⚪ Minimal · up to f8f26

The update adds the README to Plugin Hub snapshots, changes screenshot links to raw image URLs, and adds author metadata. No concrete merge-blocking behavior is identified; the change appears ready for normal checks.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (2 skipped: 2 …	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: adding README.md to publish snapshots so the Plugin Hub page displays the plugin description.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (2 skipped: 2 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

• Fix all pre-merge checks with AI

✨ Finishing Touches: 💡 1

📝 Generate docstrings: 💡

• Commit to this branch
• Create a new PR

🧪 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

• X
• Mastodon
• Reddit
• LinkedIn

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