Validate deploy.yaml with json-schema

[kjellberg]

A suggestion to #6 - catch errors in deploy.yaml better.

lib/configuration/schema.yaml sets json-schema rules for deploy.yaml.

Must be extended with validations for all available options, just want to hear your opinion first.

Example 1

# config/deploy.yaml
service: my-app
image: user/my-app
servers:
  - 192.168.0.1
registry:
  password: my-password-should-go-somewhere-safe

$ mrsk details
  ERROR (Mrsk::Configuration::ConfigurationError): The property '#/registry' did not contain a required property of 'username'

Example 2

# config/deploy.yaml
service: 123
image: user/my-app
servers:
  - 192.168.0.1
registry:
  username: my-user
  password: my-password-should-go-somewhere-safe

$ mrsk build create
  ERROR (Mrsk::Configuration::ConfigurationError): The property '#/service' of type integer did not match the following type: string

[seomamma]

I like where this is going.

[dhh]

I dig this. The error messages aren't super friendly out the box, but it's better than what we have now: which is half baked! Please do continue 👍

[kjellberg]

I'd appreciate some feedback here. I think I've covered all configuration options but there may be cases I've missed. For example I just discovered in one of my projects that env/clear/VAR didn't accept booleans (fixed now).

Therefore, I'd appreciate if you could try to run my patch with your current working configurations and tell me how it works.

It passes all tests, test fixtures and the examples in README.md. It doesn't break if new config options are introduced, just that they wont be validated until added in the schema.

So, I think this is ready to merge. Would be nice to have the schema merged into the repo, so we can keep it synced with new features and patches. I'm ready to assist should errors occur.

[dhh]

Awesome. Will check it out now. Yes, we just had an issue this morning at 37s because of lacking schema validation 😄

[dhh]

What can we do to improve the error messages? They're really quite rough right now. Like if I change "servers" to "server", I get: ERROR (Mrsk::Configuration::Error): The property '#/' did not contain a required property of 'servers'.

[dhh]

If I change builder/args to builder/arguments, it doesn't complain. Is there a way to make a list of properties exhaustive?

[dhh]

Think we might need some more exhaustive testing.

[huksley]

Note to users: While you are waiting for this and using VS Code,
add this as the first line of the deploy.yml file:

# yaml-language-server: $schema=https://raw.githubusercontent.com/kjellberg/mrsk/validate-with-json-schema/lib/mrsk/configuration/schema.yaml

[sharkovadarya]

Hello! Are there currently any plans for a JSON schema for Kamal, whether from this PR or any other source, to be available in Rails 8.0 or any subsequent releases? I see there hasn't been any activity for quite some time.

[djmb]

Superseded by #828