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

ci: release-please use node workspaces plugin #119

Merged
merged 1 commit into from
May 17, 2024

Conversation

edgarkhanzadian
Copy link
Collaborator

@edgarkhanzadian edgarkhanzadian commented May 8, 2024

Currently, release-please doesn't bump version of a local package when the dependency of that local package got updated. E.g. when models package is updated and released, we need to also bump and release query package.
Using plugin node-workspaces on release-please should technically fix that. However, there is a regression on release-please-action@4 package as it seems like on release it swaps workspace: protocol with a specific package version(seems like on v3 it worked fine). There is a fix for it in this PR: googleapis/release-please#2281 . So opening this PR as draft until release-please-action gets updated.

Summary by CodeRabbit

  • Chores
    • Downgraded release-please-action from v4 to `v3 and updated configuration parameters.
    • Added a new plugin configuration for "node-workspace" type in release-please-config.json.

Copy link

coderabbitai bot commented May 8, 2024

Warning

Rate Limit Exceeded

@edgarkhanzadian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 55 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 270b875 and 0d09311.

Walkthrough

The recent updates involve downgrading the google-github-actions/release-please-action version in the GitHub workflow, adjusting configuration parameters, adding a new constant URL in the network.model.ts file, and updating the release-please-config.json to include a new plugin configuration for a "node-workspace" type. These changes enhance configuration flexibility and add new constants without altering existing functionality.

Changes

Files Change Summary
.github/workflows/release-please.yml Downgraded release-please-action from v4 to v3, adjusted configuration parameters, and added TODO note.
packages/models/src/network.model.ts Added BESTINSLOT_API_BASE_URL_TESTNET_DUMMY constant with a specific URL value.
release-please-config.json Added a new plugin configuration for a "node-workspace" type.

A rabbit hops through code so bright,
Making changes in the night.
Constants added, versions tweaked,
Configurations now more sleek.
With every hop, the code's delight,
A software garden, growing right.
🌸🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@edgarkhanzadian edgarkhanzadian changed the title ci: release-please use node workspaces pluging ci: release-please use node workspaces plugin May 8, 2024
@edgarkhanzadian
Copy link
Collaborator Author

What do you think should we downgrade the action's version to v3 and use it that way or just wait until they release the fix for it? @fbwoolf @kyranjamie

@edgarkhanzadian edgarkhanzadian force-pushed the ci/release-please-use-node-workspaces-plugin branch 2 times, most recently from 454862e to eb77028 Compare May 17, 2024 07:59
@edgarkhanzadian edgarkhanzadian marked this pull request as ready for review May 17, 2024 07:59
@edgarkhanzadian
Copy link
Collaborator Author

I'm currently hitting an issue of having multiple versions of the same leather package in extension, so we need this one fixed quickly. I will also now publish all of the packages together to update their dependency versions.

Screenshot 2024-05-17 at 11 23 15

Copy link

@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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 55d2033 and eb77028.
Files selected for processing (3)
  • .github/workflows/release-please.yml (1 hunks)
  • packages/models/src/network.model.ts (1 hunks)
  • release-please-config.json (1 hunks)
Files skipped from review due to trivial changes (2)
  • packages/models/src/network.model.ts
  • release-please-config.json
Additional comments not posted (3)
.github/workflows/release-please.yml (3)

18-22: The downgrade to release-please-action@v3 and configuration adjustments appear correctly implemented.

Verification successful

The release-please.yml file correctly references google-github-actions/release-please-action@v3 and includes the necessary configuration adjustments.

  • The release-please-action@v3 is used with the command: manifest.
  • The default-branch is set to dev.

This confirms that the downgrade and configuration adjustments have been correctly implemented.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the integration of the new configuration in the release-please workflow.

# Test: Search for the workflow usage. Expect: Correct behavior as per new configuration.
rg --type yaml $'release-please-action@v3'

Length of output: 41



Script:

#!/bin/bash
# Description: Verify the presence and version of release-please-action in the workflow file.

# Test: Search for all instances of release-please-action to check its presence and version.
rg --type yaml 'release-please-action'

Length of output: 38



Script:

#!/bin/bash
# Description: Verify the presence and version of google-github-actions in the workflow file.

# Test: Search for all instances of google-github-actions to check its presence and version.
rg --type yaml 'google-github-actions'

Length of output: 38



Script:

#!/bin/bash
# Description: Verify the presence of any GitHub Actions in the workflow file.

# Test: Search for all instances of `uses:` to check the presence of any GitHub Actions.
rg --type yaml 'uses:'

Length of output: 207



Script:

#!/bin/bash
# Description: List all files in the .github/workflows directory to verify the presence of the workflow file.

# Test: List all files in the .github/workflows directory.
ls .github/workflows

Length of output: 57



Script:

#!/bin/bash
# Description: Display the content of the release-please.yml file to verify the configuration.

# Test: Display the content of the release-please.yml file.
cat .github/workflows/release-please.yml

Length of output: 1883


24-36: The commented-out section for release-please-action@v4 is clear and includes a TODO for future updates. Ensure to monitor the progress of the issue in the linked PR.


36-36: The deployment job configuration looks good and follows best practices for conditional execution based on the release-please job's output.

@edgarkhanzadian edgarkhanzadian force-pushed the ci/release-please-use-node-workspaces-plugin branch from 270b875 to f7eb8a0 Compare May 17, 2024 08:04
Copy link

@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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between eb77028 and 270b875.
Files selected for processing (2)
  • .github/workflows/release-please.yml (1 hunks)
  • release-please-config.json (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • .github/workflows/release-please.yml
  • release-please-config.json

target-branch: dev
default-branch: dev

# TODO: get this back when release-please-action@4 gets an update for pnpm node workspaces.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a task we can link in the commit message? Or else add here so we don't forget about this in a sea of TODOs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good point, done!

@edgarkhanzadian edgarkhanzadian force-pushed the ci/release-please-use-node-workspaces-plugin branch from f7eb8a0 to 0d09311 Compare May 17, 2024 08:18
@edgarkhanzadian edgarkhanzadian added this pull request to the merge queue May 17, 2024
Merged via the queue into dev with commit 3e6bd00 May 17, 2024
7 checks passed
@edgarkhanzadian edgarkhanzadian deleted the ci/release-please-use-node-workspaces-plugin branch May 17, 2024 08:19
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.

2 participants