Skip to content

chore: Fix lint warnings in default.yaml #3612

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

Merged
merged 1 commit into from
Jun 7, 2025

Conversation

alexandear
Copy link
Member

This PR fixes the following lint warnings:

image

See https://github.com/lima-vm/lima/actions/runs/15482949878?pr=3610

Signed-off-by: Oleksandr Redko <oleksandr.red+github@gmail.com>
@afbjorklund
Copy link
Member

afbjorklund commented Jun 7, 2025

The new YAML looks worse, now it is not just "commented out" anymore

Maybe needs to be rewritten, after the default mounts were moved to base?

i.e. templates/_default/mounts.yaml

Copy link
Member

@jandubois jandubois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM

@jandubois jandubois added this to the v1.1.2 milestone Jun 7, 2025
@jandubois
Copy link
Member

The new YAML looks worse, now it is not just "commented out" anymore

The problem is that the file is both a working template, and the canonical documentation of the schema.

I think ultimately this can only be fixed properly by moving the documentation to a proper document with YAML snippets instead of using inline YAML comments.

Maybe needs to be rewritten, after the default mounts were moved to base?

Ideally the comments should have moved to the base template, but for documentation purposes we want all the examples in a single place.

Again, I think we will need to move to separate documentation.

I was planning to work on this once I've moved the FillDefault() logic (which includes merging of override.yaml and default.yaml) to the new template merging mechanism, but don't know when I will get the time to do that.

@jandubois jandubois merged commit fafaafb into lima-vm:master Jun 7, 2025
36 of 37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants