Skip to content

Fix: PR message incorrect removal instructions#2389

Merged
ljm42 merged 1 commit intomasterfrom
fix/prRemoval
Sep 23, 2025
Merged

Fix: PR message incorrect removal instructions#2389
ljm42 merged 1 commit intomasterfrom
fix/prRemoval

Conversation

@Squidly271
Copy link
Copy Markdown
Contributor

@Squidly271 Squidly271 commented Sep 20, 2025

Summary by CodeRabbit

  • Documentation
    • Updated PR comment instructions to use the PR number (instead of version) when removing the preview plugin, improving clarity and accuracy.
  • Chores
    • Maintenance to workflow comments; no user-facing behavior changes.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 20, 2025

Walkthrough

Updated the PR workflow’s generated comment in .github/workflows/pr-plugin-upload.yml to reference the PR number for uninstall instructions instead of the version, changing two occurrences under the "To Remove" section.

Changes

Cohort / File(s) Summary
Workflow comment update
.github/workflows/pr-plugin-upload.yml
Replaced uninstall identifier from webgui-pr-${{ steps.metadata.outputs.version }} to webgui-pr-${{ steps.metadata.outputs.pr_number }} in two places within the PR comment template.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nibble through YAML with whiskers of might,
Swapping version for PR in the moonlit night.
Two tiny tweaks—hop, hop, done!
Pipelines purr, the carrots spun.
Thump of approval—merge feels right. 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Fix: PR message incorrect removal instructions" accurately and concisely summarizes the primary change, which corrects the removal instructions in the PR-generated comment to reference the PR number. It is specific enough for a reviewer scanning history and avoids vague language.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/prRemoval

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

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/pr-plugin-upload.yml (1)

362-365: Generator verified — plugin filename includes the .plg extension; align the workflow remove example.

generate-pr-plugin.sh sets PLUGIN_NAME="webgui-pr-${PR_NUMBER}.plg" and replaces PR_PLACEHOLDER throughout, so the generated plugin file is webgui-pr-<PR_NUMBER>.plg (template names/paths become webgui-pr-<PR_NUMBER>).

  • Update .github/workflows/pr-plugin-upload.yml (lines 362–365) to use:
    plugin remove webgui-pr-${{ steps.metadata.outputs.pr_number }}.plg
    or explicitly note that the Installed Plugins UI may display the name without the .plg extension.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7caf24 and 2b414a1.

📒 Files selected for processing (1)
  • .github/workflows/pr-plugin-upload.yml (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: Squidly271
PR: unraid/webgui#0
File: :0-0
Timestamp: 2025-05-31T05:10:13.120Z
Learning: Squidly271 prefers not to receive CodeRabbit reviews or feedback while PRs are in draft status. Only provide reviews after PRs are moved out of draft.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Analyze (javascript-typescript)

@ljm42 ljm42 merged commit 5a22248 into master Sep 23, 2025
4 checks passed
@ljm42 ljm42 deleted the fix/prRemoval branch September 23, 2025 23:16
@github-actions
Copy link
Copy Markdown

🧹 PR Test Plugin Cleaned Up

The test plugin and associated files for this PR have been removed from the preview environment.


🤖 This comment is automatically generated when a PR is closed.

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.

3 participants