Skip to content

Update default plugin publish to follow production version #3656

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.

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

Merged
merged 3 commits into from
Jun 5, 2025

Conversation

jjw24
Copy link
Member

@jjw24 jjw24 commented Jun 5, 2025

Update default plugin publish action to follow production version

This is already run, so it's tested working. For example https://github.com/Flow-Launcher/Flow.Launcher.Plugin.WindowsSettings/releases/tag/v1.20.0

@jjw24 jjw24 added this to the 1.20.1 milestone Jun 5, 2025
@jjw24 jjw24 self-assigned this Jun 5, 2025
@jjw24 jjw24 added the bug Something isn't working label Jun 5, 2025
Copy link

gitstream-cm bot commented Jun 5, 2025

🥷 Code experts: no user but you matched threshold 10

jjw24 has most 🧠 knowledge in the files.

See details

.github/workflows/default_plugins.yml

Knowledge based on git-blame:
jjw24: 96%

To learn more about /:\ gitStream - Visit our Docs

Copy link

gitstream-cm bot commented Jun 5, 2025

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

Copy link

github-actions bot commented Jun 5, 2025

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors and Warnings Count
❌ forbidden-pattern 22
⚠️ non-alpha-in-dictionary 13

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

@jjw24 jjw24 enabled auto-merge (squash) June 5, 2025 10:47
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the default plugins workflow to align plugin JSON versions with the production release version and simplifies the publish job by removing per-plugin change filters.

  • Remove paths-filter step and per-plugin if conditions to always publish all default plugins.
  • Add a PowerShell step to extract the version from appveyor.yml and update every plugin.json to that version.
  • Rename the job from build to publish and drop the branch path filter.
Comments suppressed due to low confidence (1)

.github/workflows/default_plugins.yml:30

  • [nitpick] PowerShell conventions favor camelCase variable names. Rename $plugin_old_ver and $plugin_new_ver to $pluginOldVersion and $pluginNewVersion for consistency.
$plugin_old_ver = Get-Content $file.FullName -Raw | ConvertFrom-Json

Copy link
Contributor

coderabbitai bot commented Jun 5, 2025

📝 Walkthrough

Walkthrough

The GitHub Actions workflow for publishing default plugins was updated to remove conditional steps based on file changes. Now, all plugins are always built and published, and their version fields are updated to match the version in appveyor.yml regardless of which files changed. The workflow job name was also updated.

Changes

Files/Paths Change Summary
.github/workflows/default_plugins.yml Removed conditional plugin build/publish logic, added version update script, renamed job to 'publish'

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant PowerShell Script

    Developer->>GitHub Actions: Push to repository
    GitHub Actions->>PowerShell Script: Run version update script
    PowerShell Script->>GitHub Actions: Update all plugin.json versions
    GitHub Actions->>GitHub Actions: Build all plugins
    GitHub Actions->>GitHub Actions: Publish all plugins
Loading

Possibly related PRs

Suggested labels

enhancement, CI/CD

Suggested reviewers

  • Garulf
  • JohnTheGr8
  • Yusyuriv
  • VictoriousRaptor
  • deefrawley
  • taooceros
  • z1nc0r3

Poem

Hopping through workflows, no more to discern,
Every plugin now gets its turn.
Versions align with a single command,
All built and published, just as planned.
No more waiting for file change signs—
CI/CD magic, by design!
🐇✨


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
🪧 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.

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 (1)
.github/workflows/default_plugins.yml (1)

28-34: Use JSON property action instead of inline regex
Manually replacing JSON via regex is error-prone. Since you already use notiz-dev/github-action-json-property later, consider updating all plugin versions in one step:

- name: Update all plugin.json versions
  uses: notiz-dev/github-action-json-property@release
  with:
    path: "./Plugins/**/plugin.json"
    prop_path: Version
    prop_value: "${{ steps.read-version.outputs.version }}"

This ensures valid JSON updates and simplifies the workflow.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3680440 and bd81156.

📒 Files selected for processing (1)
  • .github/workflows/default_plugins.yml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: gitStream workflow automation
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: build
🔇 Additional comments (1)
.github/workflows/default_plugins.yml (1)

9-9: Approve renaming job from build to publish
The new job name more accurately describes its function.

Comment on lines +19 to +27
- name: Update Plugins To Production Version
run: |
$version = "1.0.0"
Get-Content appveyor.yml | ForEach-Object {
if ($_ -match "version:\s*'(\d+\.\d+\.\d+)\.") {
$version = $matches[1]
}
}

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix PowerShell regex for version extraction
The current pattern "version:\s*'(\d+\.\d+\.\d+)\." requires a trailing dot after the version and will not match lines like version: '1.20.0'. Adjust it to:

-        Get-Content appveyor.yml | ForEach-Object {
-            if ($_ -match "version:\s*'(\d+\.\d+\.\d+)\.") {
-                $version = $matches[1]
-            }
-        }
+        Get-Content appveyor.yml | ForEach-Object {
+            if ($_ -match "version:\s*'(\d+\.\d+\.\d+)'") {
+                $version = $matches[1]
+            }
+        }

Using a YAML parser or dedicated action would be more robust.

🤖 Prompt for AI Agents
In .github/workflows/default_plugins.yml around lines 19 to 27, the PowerShell
regex used to extract the version number incorrectly expects a trailing dot
after the version string, causing it to miss valid versions like '1.20.0'.
Update the regex pattern to remove the trailing dot requirement so it matches
the full version string correctly. Consider using a YAML parser or a dedicated
GitHub Action for more reliable version extraction.

@jjw24 jjw24 merged commit bf98a73 into dev Jun 5, 2025
17 checks passed
@jjw24 jjw24 deleted the update_default_plugin_publish branch June 5, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants