fix: pr plugin promotion workflow

[pujitm]

Summary by CodeRabbit

• Chores
  • Enhanced workflow to allow manual triggering with custom inputs.
  • Improved artifact handling and plugin file discovery for greater flexibility and reliability.
  • Added better error logging for missing plugin files during workflow execution.

[coderabbitai]

Walkthrough

The GitHub Actions workflow was updated to support manual triggering with parameters, dynamic PR number handling, and improved artifact processing. The checkout step was removed, artifact download logic was enhanced, and plugin file discovery was made dynamic. No changes were made to exported or public code entities.

Changes

File(s)	Change Summary
.github/workflows/push-staging-pr-on-close.yml	Added manual trigger with inputs, removed checkout, improved artifact download and dynamic plugin file discovery

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions Workflow
    participant Artifact Store

    User->>GitHub Actions Workflow: Trigger (PR close or manual dispatch)
    GitHub Actions Workflow->>GitHub Actions Workflow: Set PR number (from event or input)
    GitHub Actions Workflow->>Artifact Store: Download artifact (using PR number)
    GitHub Actions Workflow->>GitHub Actions Workflow: Discover .plg file dynamically
    GitHub Actions Workflow->>GitHub Actions Workflow: Update plugin version and URL
    GitHub Actions Workflow->>Artifact Store: Upload updated plugin

Loading

Possibly related PRs

• feat: checkout correct branch on close #1123: Also modifies the same workflow, focusing on checkout step changes and PR handling logic.

Poem

In workflows, triggers now obey,
Both PR close and manual play!
Artifacts found with a clever scan,
No checkout needed—what a plan!
Dynamic paths, a plugin quest,
Automation tuned to its best.
🚀

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (4)

.github/workflows/push-staging-pr-on-close.yml (4)

7-17: Consider defaulting pr_merged to false and double-check boolean input syntax

A manual dispatch that automatically pushes to staging unless the caller flips a switch can be surprising.
Switching the default to false better mirrors the real-world case where a PR is not yet merged.

-      pr_merged:
+      pr_merged:
         description: 'Simulate merged PR'
         required: true
-        type: boolean
-        default: true
+        type: boolean
+        default: false

(Recent GitHub Actions releases accept type: boolean, so the field itself is fine.)

---

31-38: Harden the PR-number helper script

Small shell tweaks improve safety and readability:

-ID: pr_number
-run: |
-  if [ "${{ github.event_name }}" == "pull_request" ]; then
-    echo "pr_number=${{ github.event.pull_request.number }}" >> $GITHUB_OUTPUT
-  else
-    echo "pr_number=${{ inputs.pr_number }}" >> $GITHUB_OUTPUT
-  fi
+id: pr_number
+run: |
+  set -eu
+  if [ "${{ github.event_name }}" = "pull_request" ]; then
+      PR_NO="${{ github.event.pull_request.number }}"
+  else
+      PR_NO="${{ inputs.pr_number }}"
+  fi
+  echo "pr_number=$PR_NO" >> "$GITHUB_OUTPUT"

• set -eu fails fast on any error.
• Using a temporary variable avoids duplicating the echo line.

---

41-47: Explicitly pass github_token to the artifact-download step

dawidd6/action-download-artifact falls back to the default token, but being explicit avoids surprises and makes audits easier—especially if the default permission set changes.

-uses: dawidd6/action-download-artifact@v11
-with:
+uses: dawidd6/action-download-artifact@v11
+with:
   name_is_regexp: true
   name: unraid-plugin-.*
   path: connect-files
   pr: ${{ steps.pr_number.outputs.pr_number }}
   workflow_conclusion: success
+  github_token: ${{ secrets.GITHUB_TOKEN }}

---

58-58: Remove trailing whitespace

YAML-lint flags this line. It doesn’t break the workflow but clutters diffs.

-           
+

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f542c8e and 881cf86.

📒 Files selected for processing (1)

• .github/workflows/push-staging-pr-on-close.yml (3 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: elibosley
PR: unraid/api#1125
File: .github/workflows/main.yml:233-233
Timestamp: 2025-02-07T19:53:37.715Z
Learning: In the plugin build workflow, the TAG environment variable (previously PR) is used for display purposes in OS releases, with "PR" prefix indicating it's from a pull request.

Learnt from: elibosley
PR: unraid/api#1167
File: api/package.json:69-69
Timestamp: 2025-02-20T22:12:49.905Z
Learning: The repository has automated workflows that handle dependency compatibility checks, making manual verification redundant during dependency updates.

Learnt from: elibosley
PR: unraid/api#1120
File: plugin/package.json:1-8
Timestamp: 2025-02-05T14:43:25.062Z
Learning: The repository uses Renovate for automated dependency updates, making strict version pinning in package.json less critical as updates are handled automatically through PRs.

Learnt from: elibosley
PR: unraid/api#1120
File: .github/workflows/main.yml:240-240
Timestamp: 2025-02-05T14:44:05.679Z
Learning: In GitHub Actions workflows, Docker commands will automatically fail the build if they return a non-zero exit code, making explicit error handling unnecessary.

Learnt from: pujitm
PR: unraid/api#1352
File: packages/unraid-api-plugin-generator/src/create-plugin.ts:91-112
Timestamp: 2025-04-21T18:27:36.482Z
Learning: For utility functions like file operations in api plugin generators, pujitm prefers minimal error handling rather than verbose try/catch blocks for each operation, as errors will propagate properly to higher level error handlers.

.github/workflows/push-staging-pr-on-close.yml (1)

Learnt from: elibosley
PR: unraid/api#1125
File: .github/workflows/main.yml:233-233
Timestamp: 2025-02-07T19:53:37.715Z
Learning: In the plugin build workflow, the TAG environment variable (previously PR) is used for display purposes in OS releases, with "PR" prefix indicating it's from a pull request.

🪛 YAMLlint (1.37.1)

.github/workflows/push-staging-pr-on-close.yml

[error] 58-58: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Build Web App
• GitHub Check: Build API
• GitHub Check: Test API
• GitHub Check: Analyze (javascript-typescript)

[coderabbitai]

🛠️ Refactor suggestion

Guard against undefined inputs in non-dispatch events

inputs.pr_merged does not exist on pull_request events.
Although expressions usually coerce null to false, accessing a missing object can break unexpectedly.
Safer pattern:

-if: (github.event_name == 'pull_request' && github.event.pull_request.merged == true) || (github.event_name == 'workflow_dispatch' && inputs.pr_merged == true)
+if: >
+  (github.event_name == 'pull_request' &&
+   github.event.pull_request.merged == true) ||
+  (github.event_name == 'workflow_dispatch' &&
+   github.event.inputs.pr_merged == 'true')

This keeps each clause inside the event it belongs to and uses the documented github.event.inputs accessor.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	if: (github.event_name == 'pull_request' && github.event.pull_request.merged == true) || (github.event_name == 'workflow_dispatch' && inputs.pr_merged == true)
	if: >
	(github.event_name == 'pull_request' &&
	github.event.pull_request.merged == true) ||
	(github.event_name == 'workflow_dispatch' &&
	github.event.inputs.pr_merged == 'true')

🤖 Prompt for AI Agents

In .github/workflows/push-staging-pr-on-close.yml at line 21, the condition
accesses inputs.pr_merged without guarding against undefined inputs in
non-dispatch events, which can cause errors. Refactor the condition to check
inputs.pr_merged only when the event is workflow_dispatch by using
github.event.inputs.pr_merged, and keep each clause scoped to its event type to
avoid accessing undefined properties.

[pujitm]

isn't this the same thing, just reformatted?

[github-actions]

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL:

https://preview.dl.unraid.net/unraid-api/tag/PR1456/dynamix.unraid.net.plg

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

.github/workflows/push-staging-pr-on-close.yml (1)

21-21: Compare the boolean input as a string to avoid silent mismatch

workflow_dispatch inputs are delivered as strings ('true', 'false').
The current comparison to the literal boolean true will evaluate to false even when the user passes "true". Recommend string comparison for reliability:

-if: (github.event_name == 'pull_request' && github.event.pull_request.merged == true) || (github.event_name == 'workflow_dispatch' && inputs.pr_merged == true)
+if: >
+  (github.event_name == 'pull_request' &&
+   github.event.pull_request.merged == true) ||
+  (github.event_name == 'workflow_dispatch' &&
+   inputs.pr_merged == 'true')

🧹 Nitpick comments (3)

.github/workflows/push-staging-pr-on-close.yml (3)

7-17: default is redundant (and misleading) when required: true

Because the input is required, the dispatcher must explicitly supply a value; the default will never actually be read. Dropping it avoids confusion:

-      pr_merged:
-        description: 'Simulate merged PR'
-        required: true
-        type: boolean
-        default: true
+      pr_merged:
+        description: 'Simulate merged PR'
+        required: true
+        type: boolean

---

51-56: Minor shell robustness

Consider adding set -euo pipefail at the top of this scriptlet to ensure the job fails on any unexpected error (missing variable, failed command, etc.). It’s a cheap guardrail.

---

58-58: YAML-lint: trailing spaces

Line 58 has trailing whitespace. Remove to keep the workflow lint-clean.

-          
+

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 881cf86 and 095bf4b.

📒 Files selected for processing (1)

• .github/workflows/push-staging-pr-on-close.yml (3 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: elibosley
PR: unraid/api#1125
File: .github/workflows/main.yml:233-233
Timestamp: 2025-02-07T19:53:37.715Z
Learning: In the plugin build workflow, the TAG environment variable (previously PR) is used for display purposes in OS releases, with "PR" prefix indicating it's from a pull request.

Learnt from: elibosley
PR: unraid/api#1167
File: api/package.json:69-69
Timestamp: 2025-02-20T22:12:49.905Z
Learning: The repository has automated workflows that handle dependency compatibility checks, making manual verification redundant during dependency updates.

Learnt from: elibosley
PR: unraid/api#1120
File: plugin/package.json:1-8
Timestamp: 2025-02-05T14:43:25.062Z
Learning: The repository uses Renovate for automated dependency updates, making strict version pinning in package.json less critical as updates are handled automatically through PRs.

Learnt from: elibosley
PR: unraid/api#1120
File: .github/workflows/main.yml:240-240
Timestamp: 2025-02-05T14:44:05.679Z
Learning: In GitHub Actions workflows, Docker commands will automatically fail the build if they return a non-zero exit code, making explicit error handling unnecessary.

Learnt from: pujitm
PR: unraid/api#1352
File: packages/unraid-api-plugin-generator/src/create-plugin.ts:91-112
Timestamp: 2025-04-21T18:27:36.482Z
Learning: For utility functions like file operations in api plugin generators, pujitm prefers minimal error handling rather than verbose try/catch blocks for each operation, as errors will propagate properly to higher level error handlers.

.github/workflows/push-staging-pr-on-close.yml (2)

Learnt from: elibosley
PR: unraid/api#1125
File: .github/workflows/main.yml:233-233
Timestamp: 2025-02-07T19:53:37.715Z
Learning: In the plugin build workflow, the TAG environment variable (previously PR) is used for display purposes in OS releases, with "PR" prefix indicating it's from a pull request.

Learnt from: elibosley
PR: unraid/api#1425
File: api/dev/configs/connect.json:2-3
Timestamp: 2025-06-20T21:05:24.582Z
Learning: When reviewing configuration files in refactoring PRs, avoid suggesting field name changes that could break compatibility with existing code that references those fields, even if the naming doesn't follow ideal conventions.

🪛 YAMLlint (1.37.1)

.github/workflows/push-staging-pr-on-close.yml

[error] 58-58: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Build Web App
• GitHub Check: Test API
• GitHub Check: Cloudflare Pages

🔇 Additional comments (1)

.github/workflows/push-staging-pr-on-close.yml (1)

41-47: Double-check input names supported by dawidd6/action-download-artifact@v11

name_is_regexp, pr, and workflow_conclusion were introduced in v6–v10 of the action and occasionally change between major versions. Please verify they still exist on v11; otherwise the step will silently skip the download.