feat: add helm-release workflow #8320
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis change introduces a new GitHub Actions workflow, Changes
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
Poem
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
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-helmaction 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-actionis correctly configured to release charts from the current directory, using the GitHub token for authentication and skipping existing charts.
|
@azhavoro PTAL |
|
|
I have deep interest in this feature and would like to have cvat helm charts published to GH pages. |
|
From helm/chart-releaser-action docs:
We don't need to create a new release with this action because the current release pipeline is completely different. This action is great for repositories that only host the helm chart, but we are hosting the chart along with the application source code, and we need a different solution. |
Motivation and context
Creating a public Helm chart registry for CVAT will:
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
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit