Skip to content

Commit

Permalink
fix some changes that were supposed to go in the rejected ideas.
Browse files Browse the repository at this point in the history
Signed-off-by: Danilo Patrucco <[email protected]>
  • Loading branch information
danilo-patrucco committed Oct 10, 2024
1 parent 534e367 commit 4e07227
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions hips/hip-0019.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ Documentation for the `.helmlintconfig.yaml` file and the `--lint-config-file` f
PR #[13257](https://github.com/helm/helm/pull/13257) created in the Helm/helm repository in gitlab

## Open Issues
- Developing an Effective and User-Friendly Pattern Syntax and Rule Configurations: We are considering the design of a flexible and intuitive pattern syntax for the `.helmlintconfig.yaml` file that supports rule-specific configurations and exclusions. This enables users to control lint behaviors on a per-rule basis. Additionally, introducing named lint rules, akin to those in yamllint, will provide a foundation for more sophisticated configuration features, including rule-specific settings and extensions of a "default" configuration set. This could also facilitate the introduction of features like error code suppression across the board (hypothetically, using `errorCode: H019`). This change will require a strong refactoring of the linting code to accommodate the new configuration and rule management systems.
- Developing an Effective and User-Friendly Pattern Syntax: We are considering the design of a flexible and intuitive pattern syntax for the `.helmlintconfig.yaml` file. This syntax would ideally support rule-specific configurations and exclusions, allowing users to finely control lint behaviors on a per-rule basis.
- In-File Annotations for Excluding Chart Sections: Exploring the possibility of in-file annotations that would let developers temporarily exclude specific sections of a chart from linting. This feature would provide granular control directly within Helm chart files.
- Future Enhancements and Extensibility: The Open issues proposed changes to the Helm linting system will likely require significant modifications to the existing codebase, the basic design outlined in HIP-0019 won't. As such, these future enhancements could be implemented in phases, starting with foundational features like rule naming and extending to more complex configurations. This phased approach will help ensure stability and usability while expanding the linting capabilities of Helm.

## Rejected Ideas
None at this time.
- Rule Naming and Configurations: Currently, Helm does not support named lint rules. Introducing named rules is a foundational step that would enable us to implement more sophisticated configuration features, such as rule-specific exclusions and settings. Naming rules would facilitate clearer and more maintainable configurations, laying the groundwork for future enhancements.
- Composing configuration from "default" configuration (e.g. similar to https://yamllint.readthedocs.io/en/stable/configuration.html#extending-the-default-configuration), by adding additional files that reference a default configuration and extend it.

## References
- This proposal aligns with practices outlined in [HIP-0001](https://github.com/helm/community/blob/master/hips/hip-0001.md).

0 comments on commit 4e07227

Please sign in to comment.