-
Notifications
You must be signed in to change notification settings - Fork 0
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
Small pipeline updates #13
Conversation
Warning Rate limit exceeded@ausias-armesto has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 49 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. WalkthroughWalkthroughThe pull request introduces significant updates to the GitHub Actions workflows and documentation. It enhances the "Close Release" workflow description, restructures the build and publish jobs for better modularity, and improves command robustness by adding quotation marks around variables. Additionally, the README has been restructured to focus on contribution guidelines instead of deployment instructions, reflecting a shift in emphasis. Changes
Possibly related PRs
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please document changelog handling and deployment in README
There was a problem hiding this 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
Outside diff range and nitpick comments (1)
README.md (1)
5-5
: Consider renaming the section title to "Contribution process".The current section title "Deployment process" is misleading, as the content is about the contribution process, not deployment. A more appropriate title would be "Contribution process" to align with the content.
Apply this diff to update the section title:
-## Deployment process +## Contribution process
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- .github/workflows/README.md (1 hunks)
- .github/workflows/build.yaml (2 hunks)
- .github/workflows/merge.yaml (1 hunks)
- .github/workflows/release.yaml (2 hunks)
- README.md (1 hunks)
Files skipped from review due to trivial changes (2)
- .github/workflows/merge.yaml
- .github/workflows/release.yaml
Additional context used
LanguageTool
README.md
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...ployment process To contribute to this repository you will need to create a pull request....(AI_HYDRA_LEO_MISSING_COMMA)
actionlint
.github/workflows/build.yaml
41-41: label "self-hosted-hoprnet-small" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-14.0", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-13.0", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "macos-12.0", "macos-11", "macos-11.0", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
Additional comments not posted (4)
README.md (1)
7-7
: Ignore the static analysis hint about the missing comma.The sentence "To contribute to this repository you will need to create a pull request." is grammatically correct without the comma. Adding a comma after "repository" is optional and a matter of style preference. The static analysis hint can be safely ignored.
Tools
LanguageTool
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...ployment process To contribute to this repository you will need to create a pull request....(AI_HYDRA_LEO_MISSING_COMMA)
.github/workflows/README.md (1)
20-29
: Excellent enhancement to the "Close Release" workflow description!The updated description provides a comprehensive list of tasks performed by the workflow, including:
- Publishing the version for use in the latest release channel
- Publishing the artifact in both the internal Google Artifact Registry and the public NPM registry
- Creating a GitHub release
- Tagging the code
- Adding a changelog with merged PRs
- Bumping the new version by opening a new PR
- Sending a Zulip notification
This detailed enumeration clarifies the workflow's functionality and the steps involved in the release process, making it easier for users and contributors to understand.
.github/workflows/build.yaml (2)
Line range hint
12-38
: LGTM!The
build
job looks good. It follows a standard CI workflow by checking out the repository, setting up Node.js, building, linting, formatting, and testing the application. The job configuration is correct and there are no apparent issues.Tools
actionlint
14-14: label "self-hosted-hoprnet-small" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-14.0", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-13.0", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "macos-12.0", "macos-11", "macos-11.0", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
Line range hint
39-70
: Thepublish
job looks good, and the custom runner label is valid.The
publish
job follows a standard publishing workflow by checking out the repository, setting up Node.js, setting up GCP, and publishing the package. The job configuration is correct and there are no apparent issues.Regarding the static analysis hint about the unknown runner label
self-hosted-hoprnet-small
:
- This is likely a valid custom label for a self-hosted runner in your organization.
- The static analysis tool is unaware of custom labels and is generating a false positive.
- You can safely ignore this hint, as it is not a blocker for the workflow.
Tools
actionlint
41-41: label "self-hosted-hoprnet-small" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-14.0", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-13.0", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "macos-12.0", "macos-11", "macos-11.0", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
Changelog is auto-generated automatically from the PR merged into main. No need to do anything from the development side other than contribute always to main from a PR. The changelog will be included in the body of the Github Release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's try the new workflow then
Some small improvements to align with other repository workflows
Summary by CodeRabbit
README.md
to focus on contribution guidelines, removing specific deployment instructions.publish
job in the build workflow for improved modularity.gcloud
commands.