Skip to content

chore: keep preview plg when merging release-please pr's #1312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
pujitm merged 2 commits into from
Apr 2, 2025
Merged

chore: keep preview plg when merging release-please pr's #1312

pujitm merged 2 commits into from
Apr 2, 2025

Conversation

@pujitm
Copy link
Member

@pujitm pujitm commented Apr 2, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores
    • Enhanced the deployment process to clearly distinguish between production and preview releases.
    • Added verification steps to ensure all required production assets are present, improving the overall reliability of plugin updates.

@pujitm pujitm requested a review from elibosley as a code owner April 2, 2025 18:25
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 2, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the GitHub Actions workflow to handle both production and preview plugin builds based on the release status. When a release is created, the workflow sets the BASE_URL to the production URL, builds the plugin, and moves the output to a deploy-prod directory. A new verification step checks for the expected production plugin files (.plg and .txz). For non-release builds, it sets the BASE_URL to the preview URL and performs a build using the deploy directory. Additionally, the upload step is updated to source assets from deploy-prod.

Changes

File(s) Change Summary
.github/workflows/main.yml - Added condition to set BASE_URL to production URL on release builds and preview URL otherwise.
- Executes build command accordingly and moves production build output to deploy-prod.
- Introduced a step to verify existence of .plg and .txz files in deploy-prod.
- Modified upload step to use deploy-prod.
- Retained deploy directory listing step.

Suggested reviewers

  • mdatelle
  • zackspear

Poem

In the world of YAML and codes so bright,
A release and a non-release dance in the night,
Production files verified with care,
Preview builds still show up there,
With commands precise and workflows so neat,
Our deployment path is a rhythmic beat,
Cheers to code that makes our process complete!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 9634e22 and 897ca3a.

📒 Files selected for processing (1)
  • .github/workflows/main.yml (3 hunks)
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 2, 2025

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/PR1312/dynamix.unraid.net.plg

coderabbitai[bot]
coderabbitai bot reviewed Apr 2, 2025
View reviewed changes
Copy link
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: 1

🧹 Nitpick comments (2)
.github/workflows/main.yml (2)

388-393: Production Plugin Build: Verify the Move Command
The production build branch is well structured: setting the BASE_URL to the production endpoint, running the build, and then moving the generated assets from ./deploy to ./deploy-prod isolates production artifacts. Consider adding error handling (or checking that the mv command succeeds) to prevent unnoticed failures if the move does not work as expected.

401-410: Preview Plugin Files Verification
Listing the contents of the ./deploy directory before checking for .plg and .txz files is a useful debugging step. The conditional checks help ensure that the preview plugin files exist as expected.

Note: Ensure that the glob pattern [ ! -f ./deploy/*.plg ] works as expected in your shell; in some cases, it might be beneficial to verify via an alternative method if multiple files are expected.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1515385 and 9634e22.

📒 Files selected for processing (1)
  • .github/workflows/main.yml (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
.github/workflows/main.yml (2)

395-398: Preview Plugin Build: Clear Separation of Build Processes
Re-running the build with the preview BASE_URL after moving the production build ensures both builds are generated independently. The logic is clear and meets the objective of keeping preview builds available when merging release-please PRs.

450-453: Upload Release Assets from Production Build
Uploading the release assets from deploy-prod ensures that only the production plugin files are released. This change aligns with the intended workflow where production artifacts are preserved separately from preview builds.

@pujitm pujitm merged commit 3911be3 into main Apr 2, 2025
6 of 8 checks passed
@pujitm pujitm deleted the fix/pnpm-store branch April 2, 2025 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@elibosley elibosley elibosley approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pujitm @elibosley