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

Add an action to automatically generate release PRs #4306

Merged

Conversation

jfdoming
Copy link
Contributor

@jfdoming jfdoming commented Feb 6, 2025

Slowly trying to make the release process easier. To start, I wrote a script+manually-triggered action which will automatically create a release PR for the "next" version and bump all package.json files to that version. If you don't specify a version, it infers it using this logic which to me seems to mirror how we already do releases (pseudocode):

if (day_of_month <= 25) {
  patchVersion++;
} else {
  patchVersion = 0;
  minorVersion = next_month();
  majorVersion = year_of_next_month();
}

See this test run which generated jfdoming#5.

I'm thinking eventually we can move the release note generation to this action as well and save an extra round trip with CI! It would also be nice to automatically generate the release docs. One day...

@actual-github-bot actual-github-bot bot changed the title Add an action to automatically generate release PRs [WIP] Add an action to automatically generate release PRs Feb 6, 2025
Copy link

netlify bot commented Feb 6, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 8629f1e
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67a43fb66e1d400008336d99
😎 Deploy Preview https://deploy-preview-4306.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

github-actions bot commented Feb 6, 2025

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
16 6.79 MB → 6.81 MB (+18.37 kB) +0.26%
Changeset
File Δ Size
locale/de.json 📈 +18.37 kB (+23.45%) 78.37 kB → 96.74 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/de.js 78.37 kB → 96.74 kB (+18.37 kB) +23.45%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/uk.js 111.11 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/wide.js 102.8 kB 0%
static/js/nl.js 83.87 kB 0%
static/js/en-GB.js 99.33 kB 0%
static/js/en.js 99.34 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/useAccountPreviewTransactions.js 1.69 kB 0%
static/js/pt-BR.js 103.29 kB 0%
static/js/narrow.js 84.94 kB 0%
static/js/AppliedFilters.js 10.52 kB 0%
static/js/ReportRouter.js 1.59 MB 0%
static/js/index.js 4.29 MB 0%

Copy link
Contributor

github-actions bot commented Feb 6, 2025

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
1 1.33 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.33 MB 0%

@jfdoming jfdoming changed the title [WIP] Add an action to automatically generate release PRs Add an action to automatically generate release PRs Feb 6, 2025
Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

Walkthrough

The pull request introduces a new Bash script and a GitHub Actions workflow. The Bash script, located in the .github/actions/ directory, automates the version bumping process for specific package JSON files. It accepts a version argument, or if none is provided, calculates a new version based on the current date using the YY.MM.patch format, updating the files with jq. Additionally, a new workflow file named generate-release-pr.yml has been created, which is manually triggered. This workflow checks out a specified commit or branch, executes the version bumping script, extracts the updated version from the package JSON file, and creates a release pull request using an external action. These changes implement new mechanisms for managing package versions and automating the release process.

Suggested labels

:sparkles: Merged

Suggested reviewers

  • MatissJanis

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fc8b5ed and 8629f1e.

📒 Files selected for processing (1)
  • .github/actions/bump-package-versions (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/actions/bump-package-versions
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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: 3

🧹 Nitpick comments (1)
.github/workflows/generate-release-pr.yml (1)

29-35: Enhance PR creation configuration.

Consider adding:

  1. PR labels for better categorization
  2. Base branch configuration
  3. PR template or more detailed description
 - name: Create PR
   uses: peter-evans/create-pull-request@v7
   with:
     commit-message: '🔖 (${{ steps.bump_package_versions.outputs.version }})'
     title: '🔖 (${{ steps.bump_package_versions.outputs.version }})'
-    body: 'Generated by [generate-release-pr.yml](../tree/master/.github/workflows/generate-release-pr.yml)'
+    body: |
+      ## Release v${{ steps.bump_package_versions.outputs.version }}
+      
+      This PR was automatically generated by [generate-release-pr.yml](../tree/master/.github/workflows/generate-release-pr.yml).
+      
+      ### Changes
+      - Bumped version to ${{ steps.bump_package_versions.outputs.version }}
+      - Updated package.json files
+    labels: |
+      release
+      automated
     branch: 'release/v${{ steps.bump_package_versions.outputs.version }}'
+    base: ${{ github.event.inputs.ref }}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a23a285 and fc8b5ed.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4306.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • .github/actions/bump-package-versions (1 hunks)
  • .github/workflows/generate-release-pr.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Functional
  • GitHub Check: Visual regression
🔇 Additional comments (2)
.github/actions/bump-package-versions (2)

1-1: Add execute permissions to the script.

The script needs to be executable to run in the workflow.

Run this command to verify and fix permissions:

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Check if script is executable
ls -l .github/actions/bump-package-versions
# Make it executable if needed
chmod +x .github/actions/bump-package-versions

Length of output: 180


Script execution permissions are correctly set.
The permissions on .github/actions/bump-package-versions are -rwxr-xr-x, which means it is already executable. No further changes are needed.


13-15: Verify the version calculation logic.

The version calculation logic assumes:

  1. Current versions follow YY.MM.patch format
  2. Day 25 is the cutoff for patch vs minor version bump
  3. Month rollover increments year

Please verify these assumptions align with project requirements.

.github/actions/bump-package-versions Outdated Show resolved Hide resolved
.github/workflows/generate-release-pr.yml Show resolved Hide resolved
.github/workflows/generate-release-pr.yml Show resolved Hide resolved
Copy link
Contributor

@matt-fidd matt-fidd left a comment

Choose a reason for hiding this comment

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

Nice!!

One step closer to one-button releases

@jfdoming jfdoming merged commit 4a7b0e7 into actualbudget:master Feb 6, 2025
20 checks passed
@jfdoming jfdoming deleted the jfdoming/auto-generate-release-prs branch February 6, 2025 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants