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

Small pipeline updates #13

Merged
merged 5 commits into from
Sep 17, 2024
Merged

Small pipeline updates #13

merged 5 commits into from
Sep 17, 2024

Conversation

ausias-armesto
Copy link
Contributor

@ausias-armesto ausias-armesto commented Sep 17, 2024

Some small improvements to align with other repository workflows

Summary by CodeRabbit

  • Documentation
    • Enhanced the "Close Release" workflow documentation for clarity on tasks performed.
    • Restructured the README.md to focus on contribution guidelines, removing specific deployment instructions.
  • New Features
    • Introduced a separate publish job in the build workflow for improved modularity.
  • Bug Fixes
    • Improved command robustness by adding quotation marks around variables in gcloud commands.

@ausias-armesto ausias-armesto self-assigned this Sep 17, 2024
Copy link

coderabbitai bot commented Sep 17, 2024

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 @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 9bc77f0 and 8c3cc98.

Walkthrough

Walkthrough

The 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

File Change Summary
.github/workflows/README.md Added a detailed description of the "Close Release" workflow, enumerating tasks performed during the release process.
.github/workflows/build.yaml Split the build-and-publish job into two jobs: build and publish, removing GCP setup from the build job and isolating it in the new publish job.
.github/workflows/merge.yaml Enhanced command robustness by adding double quotes around the ${{ vars.NPM_PACKAGE_NAME }} variable in gcloud command lines.
.github/workflows/release.yaml Similar to merge.yaml, added quotation marks around the ${{ vars.NPM_PACKAGE_NAME }} variable in gcloud command invocations to ensure proper argument handling.
README.md Removed detailed deployment instructions and added a section on contribution guidelines, directing users to GitHub Actions documentation.

Possibly related PRs

  • Use the standard setup actions #12: The changes in the .github/workflows/build.yaml, .github/workflows/merge.yaml, and .github/workflows/release.yaml files involve updates to the setup steps for Node.js and Google Cloud Platform (GCP), which are relevant to the overall workflow enhancements discussed in the main PR regarding the "Close Release" workflow.

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 generate interesting stats about this repository and render them as a table.
    -- @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.

@ausias-armesto ausias-armesto requested a review from a team September 17, 2024 08:19
Copy link
Member

@esterlus esterlus left a 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

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

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

Commits

Files that changed from the base of the PR and between 25cf2e0 and 9bc77f0.

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: The publish 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)

@ausias-armesto
Copy link
Contributor Author

Please document changelog handling and deployment in README

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

Copy link
Member

@esterlus esterlus left a 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

@esterlus esterlus merged commit 4cab129 into main Sep 17, 2024
4 checks passed
@esterlus esterlus deleted the ausias/update-pipelines branch September 17, 2024 10:14
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