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: add helm-release workflow #8320

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

ducviet00
Copy link

@ducviet00 ducviet00 commented Aug 19, 2024

Motivation and context

Creating a public Helm chart registry for CVAT will:

  • simplify the deployment process for users by providing a standardized way to deploy CVAT on k8s clusters.
  • make it easier for users to get started with CVAT in cloud-native envs.

Related issue: #8244

How has this been tested?

I was unable to successfully test this PR because the Helm release workflow depends on the docs workflow, and my forked repository keeps failing during the docs workflow. To address this, I removed the dependency between the Helm release workflow and the docs workflow.

The Helm release does not override anything in the docs workflow on the gh-pages branch because it only adds the index.yaml file. You can verify this by checking the gh-pages branch of my forked repository: GitHub Repo.

The documentation page appears to be working correctly: Docs Page.

Here is the Helm chart index file: index.yaml.

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features
    • Introduced a new automated workflow for releasing Helm charts, synchronized with documentation updates to streamline the deployment process.

Copy link
Contributor

coderabbitai bot commented Aug 19, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This change introduces a new GitHub Actions workflow, helm-release.yml, which automates the release of Helm charts in synchronization with documentation updates. Triggered upon completion of the documentation workflow, it enhances the CI/CD pipeline by integrating Helm chart releases, thereby streamlining the deployment process for applications utilizing Helm.

Changes

File Change Summary
.github/workflows/helm-release.yml New workflow created to automate Helm chart releases.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs Workflow
    participant Helm Release
    participant GitHub

    User->>Docs Workflow: Start documentation update
    Docs Workflow->>GitHub: Complete documentation
    GitHub->>Helm Release: Trigger Helm release workflow
    Helm Release->>GitHub: Checkout repository
    Helm Release->>GitHub: Configure Git
    Helm Release->>Helm: Install Helm
    Helm Release->>Helm: Run chart-releaser action
    Helm Release->>GitHub: Release Helm charts
Loading

Poem

🐰 In the meadow, new charts bloom,
Automation dispels the gloom.
With Docs aligned, a graceful dance,
Helm releases take their chance.
Hops of joy in a CI spree,
Let’s deploy with glee, whee! 🌼✨


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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between afbb143 and 6912646.

Files selected for processing (1)
  • .github/workflows/helm-release.yml (1 hunks)
Additional comments not posted (4)
.github/workflows/helm-release.yml (4)

1-12: LGTM! Workflow trigger and job setup are appropriate.

The workflow is correctly triggered by the completion of the Docs workflow, and the permissions are set appropriately for the intended operations.


13-23: LGTM! Checkout and Git configuration are well-configured.

The repository is checked out with submodules and full history, and Git is configured to attribute commits to the GitHub actor.


25-26: LGTM! Helm installation step is correctly set up.

The azure/setup-helm action is used to install Helm, which is necessary for the chart-releaser step.


28-34: LGTM! Chart-releaser action setup is appropriate.

The helm/chart-releaser-action is correctly configured to release charts from the current directory, using the GitHub token for authentication and skipping existing charts.

@ducviet00
Copy link
Author

@azhavoro PTAL

Copy link

sonarcloud bot commented Sep 4, 2024

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.

1 participant