Skip to content
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

feat: re-add homebrew bump flow #151

Merged
merged 1 commit into from
Nov 3, 2024

Conversation

chenrui333
Copy link
Contributor

@chenrui333 chenrui333 commented Nov 2, 2024

re-add homebrew bump flow per formula rename.


using official brew actions this time so that the npmjs artifact issue would be resolved see here and here

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Signed-off-by: Rui Chen <rui@chenrui.dev>
Copy link

stackblitz bot commented Nov 2, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link
Contributor

coderabbitai bot commented Nov 2, 2024

📝 Walkthrough

Walkthrough

A new GitHub Actions workflow file named release.yml has been added to automate tasks upon the creation of a release. This workflow includes a job called homebrew, which runs on macOS and consists of steps to set up Homebrew, configure the Git user, and bump specified packages. The workflow aims to streamline package management by automatically updating formulae during the release process.

Changes

File Change Summary
.github/workflows/release.yml Introduced a new workflow for automated package management on release creation, including setup of Homebrew, Git user configuration, and package bumping.

Sequence Diagram(s)

Loading
sequenceDiagram
    participant User
    participant GitHub
    participant Homebrew
    participant Git

    User->>GitHub: Create Release
    GitHub->>Homebrew: Trigger Workflow
    Homebrew->>Homebrew: Set up Homebrew
    Homebrew->>Git: Configure Git user
    Homebrew->>Homebrew: Bump packages
    Git->>Homebrew: Update formulae

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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 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: 2

🧹 Outside diff range and nitpick comments (2)
.github/workflows/release.yml (2)

3-6: Consider filtering releases based on type.

The workflow currently runs on all created releases. Consider filtering for specific release types (e.g., excluding pre-releases or drafts) if that aligns with your versioning strategy.

 on:
   release:
     types:
-      - created
+      - published

1-24: Consider enhancing workflow reliability and monitoring.

While the basic workflow is functional, consider these improvements:

  1. Add status checks or notifications for failed bumps
  2. Implement retry logic for transient failures
  3. Add workflow artifacts to preserve logs
 jobs:
   homebrew:
     runs-on: macos-latest
+    outputs:
+      bump-status: ${{ steps.bump.outputs.status }}
     steps:
       # ... existing steps ...
       - name: Bump packages
+        id: bump
         uses: Homebrew/actions/bump-packages@master
         with:
           token: ${{ secrets.COMMITTER_TOKEN }}
           formulae: repomix
+      - name: Upload logs
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: homebrew-logs
+          path: ~/.homebrew/logs/
+
+  notify:
+    needs: homebrew
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - name: Notify status
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const status = context.needs.homebrew.outputs['bump-status']
+            const message = `Homebrew bump ${status ? 'succeeded' : 'failed'}`
+            github.rest.issues.createComment({
+              ...context.repo,
+              issue_number: context.issue.number,
+              body: message
+            })
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d1d6472 and ffea8ad.

📒 Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/release.yml (1)

23-24: Verify COMMITTER_TOKEN permissions and consider parameterizing the formula name.

The workflow uses a sensitive token and a hardcoded formula name. Please ensure:

  1. The COMMITTER_TOKEN has minimal required permissions
  2. Consider making the formula name configurable through workflow inputs

.github/workflows/release.yml Show resolved Hide resolved
.github/workflows/release.yml Show resolved Hide resolved
@yamadashy
Copy link
Owner

yamadashy commented Nov 3, 2024

@chenrui333
Thank you for the PR!
I was thinking about re-adding the previous automation, but moving to official Homebrew actions is definitely an improvement.

I've checked the source of actions, and this new approach is more robust and trustworthy.

Ready to merge once CI passes!

Copy link

codecov bot commented Nov 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.54%. Comparing base (0674a69) to head (ffea8ad).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #151   +/-   ##
=======================================
  Coverage   77.54%   77.54%           
=======================================
  Files          36       36           
  Lines        1759     1759           
  Branches      327      327           
=======================================
  Hits         1364     1364           
  Misses        395      395           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yamadashy yamadashy merged commit 8b9b336 into yamadashy:main Nov 3, 2024
36 checks passed
@yamadashy
Copy link
Owner

@chenrui333
Thank you so much for improving our Homebrew automation!

Feel free to open more PRs if you find anything else that could be enhanced!

@chenrui333
Copy link
Contributor Author

yeah, totally, thanks for the support!

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.

None yet

2 participants