#152 - Super-linter implementation

[AgusCastro]

What's this PR do?

Solves #152

Summary by CodeRabbit

New Features:

• None

Bug Fixes:

• None

Documentation:

• None

Refactor:

• None

Style:

• None

Tests:

• None

Chores:

• Implemented a new GitHub Actions workflow named "Lint Code Base". This workflow will automatically check the code for any linting errors whenever changes are pushed to the main branch or a pull request is made. This ensures that our codebase remains clean and adheres to our coding standards, improving the overall quality of our software.

[coderabbitai[bot]]

Walkthrough

This change introduces a new GitHub Actions workflow, "Lint Code Base", which is set to run on every push to the main branch and on pull requests targeting the main branch. The workflow is designed to maintain code quality by linting the code base using the super-linter/slim@v5 action.

Changes

File

Summary

.github/workflows/lint.yml

A new GitHub Actions workflow file named "Lint Code Base" has been added. This workflow runs on push to the main branch and pull requests targeting the main branch. It operates on an Ubuntu environment and has permissions to read contents and packages, and write statuses. The workflow checks out the code using the actions/checkout@v4 action and then lints the code base using the super-linter/slim@v5 action.

Poem

🍂 As the leaves fall, so does the lint from our code, 🍁

With each push and pull, we lighten the load. 🎃

On this All Hallows' Eve, under the moon's glow, 🌕

Our code becomes cleaner, like the first winter's snow. ❄️

So here's to the linter, our silent night guard, 🛡️

Keeping our codebase, from becoming too hard! 🎉

Happy Halloween, and to all a good night, 🌙

May your code be merry, and always just right! 🐇

Validation with GitHub issue(Beta)

### Assessment of the PR changes against GitHub Issue | Aspect | Aligns with the linked issue | Explanation | | --- | --- | --- | | Use of "super-linter" | ☑️ | The pull request includes the use of "super-linter" in the GitHub Actions workflow, which aligns with the issue's requirement. | | Workflow trigger events | ☑️ | The workflow is set to run on push and pull_request events on the main branch, which is a common practice and doesn't contradict the issue. | | Environment and permissions | ☑️ | The workflow runs on an Ubuntu environment with read and write permissions, which is not specified in the issue but doesn't contradict it. | | Configuration of "super-linter" | ☑️ | The "super-linter" is configured with environment variables, which aligns with the issue's requirement for easy configuration. | | Testing of the linting process | ❌ | The pull request does not mention any testing of the linting process with "super-linter", which is a requirement in the issue. |

---

Tips

### Chat with CodeRabbit Bot (`@coderabbitai`) - If you reply to a *review comment* from CodeRabbit, the bot will automatically respond. - To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment - Note: Review comments are made on code diffs or files, not on the PR overview. - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai help` to get help. - `@coderabbitai resolve` to resolve all the CodeRabbit review comments. Note: For conversation with the bot, please use the review comments on code diffs or files. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.json). - 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/coderabbit-overrides.json`