ci(workflows): update GitHub Actions for Helm chart automation

TartanLeGrand commented 5 months ago

Overview 📝

This update revises the GitHub Action workflow for releasing Helm charts, focusing on improving the process for pushing tags and managing releases to an OCI registry.

Details of Changes 🛠️

Trigger Adjustment: The workflow now triggers on any new tag push, rather than on branch pushes, aligning with best practices for release management.
Helm and Docker Integration: Enhanced to use the latest actions for Helm setup and Docker login, ensuring compatibility and security.
Release Management: Utilizes helm/chart-releaser-action@v1.6.0 for packaging and docker/login-action@v3 for pushing charts to a specified OCI registry.
Git Configuration: Standardizes Git setup for actions to ensure proper authorship is recorded.
Deployment Process: Added detailed steps for logging into 8gears.container-registry.com and pushing Helm charts directly to this OCI registry.

Justification 📊

These changes are designed to streamline the release process by:

Ensuring that releases are tied to version tags, which helps in tracking and rollback.
Automating the distribution of charts to our OCI registry, which simplifies deployment and access management.
Improving security and maintainability of the deployment scripts.

Discussion Point 🤔

In response to Issue #27 regarding the automation of Helm chart deployments to an OCI registry: while this setup enhances our deployment capabilities, I'd like to propose a discussion about potentially deploying our charts directly on GitHub Pages as well. This could simplify access and distribution. What are the considerations against using GitHub Pages for this purpose?

Action Requested 📬

Please review the proposed changes for their impact on our release process. Feedback, suggestions, or approval for merge would be greatly appreciated to enhance our Helm chart management strategy.

Summary by CodeRabbit

Chores
- Added GitHub Actions workflows for commit checks, linting, and chart releases.
- Updated .gitignore to exclude .idea and .vscode directories.

Vad1mo commented 5 months ago

@coderabbitai review

coderabbitai[bot] commented 5 months ago

Actions performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] commented 5 months ago

Walkthrough

The recent updates introduce several GitHub Actions workflows to enhance the CI/CD pipeline. These workflows include checks for conventional commit messages, linting and testing Helm charts, releasing charts on tag pushes, and automating releases. Additionally, .idea and .vscode directories are now ignored in the .gitignore file. These changes aim to streamline development processes and ensure code quality.

Changes

Files/Paths	Change Summary
`.github/workflows/conventional-commits-check.yaml`	Added a workflow to check for conventional commit messages on pull requests to the `master` branch.
`.github/workflows/lint.yaml`	Introduced a workflow to lint and test Helm charts on pull requests.
`.github/workflows/push.yaml`	Created a workflow to release Helm charts on tag pushes, including tasks like code checkout, Git configuration, and chart pushing.
`.github/workflows/release.yaml`	Added a workflow to automate releases using the `google-github-actions/release-please-action@v4`.
`.gitignore`	Updated to ignore `.idea` and `.vscode` directories.

Poem

In the code’s domain, where actions flow, New workflows sprout, making progress grow. Commits now checked, charts linted with care, Releasing with ease, no more despair. Ignored are the files from IDE's nest, Our CI/CD pipeline, truly the best!

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

Vad1mo commented 5 months ago

I created some new issues related to that.

https://github.com/8gears/n8n-helm-chart/issues/97

8gears / n8n-helm-chart