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

Switch to super-linter for CI Linting using GitHub Actions #17

Open
1 of 2 tasks
ulises-jeremias opened this issue Oct 2, 2023 · 2 comments
Open
1 of 2 tasks

Comments

@ulises-jeremias
Copy link
Member

ulises-jeremias commented Oct 2, 2023

Describe the feature

I propose switching our CI linting setup, which includes shellcheck, markdownlint, eslint, and others, to use super-linter exclusively for GitHub Actions. super-linter is a comprehensive and centralized linter that supports multiple languages, providing a unified linting experience.

Use Case

There are some benefits of super-linter:

  • Unified Linting: super-linter supports a wide range of languages and linters, providing a unified linting solution for our GitHub Actions workflow.

  • Easy Configuration: Simplifies configuration by having a single .github/linters configuration file.

  • Consistent Output: Standardizes the output format for linting results across different languages and linters.

  • Extensibility: Supports adding or customizing linters easily, making it adaptable to our specific requirements.

Proposed Solution

  1. Configure super-linter:

    • Create or update the .github/workflows configuration file to specify the linters and configurations needed.
  2. GitHub Actions Workflows:

    • Update the GitHub Actions workflow files to use super-linter for linting instead of the actual implementation
  3. Testing:

    • Thoroughly test the linting process with super-linter in the GitHub Actions workflow to ensure it covers all relevant languages and provides accurate results. You can test this by submitting a PR

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

Version used

latest

Environment details (OS name and version, etc.)

any

@Siddharth9890
Copy link

hey @ulises-jeremias can i try this task? feel free to assign it to me

@ulises-jeremias
Copy link
Member Author

@Siddharth9890 sure! let me know if you need any help on this!

@ulises-jeremias ulises-jeremias moved this from 🆕 New to 🏗 In progress in NaNLabs public roadmap Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🏗 In progress
Development

No branches or pull requests

2 participants