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

Include comparison yaml files in default configuration #571

Closed
chrispcampbell opened this issue Dec 2, 2024 · 0 comments · Fixed by #574 or #573
Closed

Include comparison yaml files in default configuration #571

chrispcampbell opened this issue Dec 2, 2024 · 0 comments · Fixed by #574 or #573

Comments

@chrispcampbell
Copy link
Contributor

When I added support for defining comparisons in yaml format in #315 (like we already had for checks), I stopped short of making changes in plugin-check so that comparison files are detected automatically.

I will change plugin-check (the template-tests code specifically) so that it picks up comparison yaml files with the following glob pattern:

{projDir}/**/comparisons/*.yaml

The current default glob pattern for check tests is:

{projDir}/**/*.check.yaml

We can continue to accept that one (for backward compatibility, since the create package was using that format until now), but will amend it to also include files under a checks directory:

{projDir}/**/*.check.yaml
{projDir}/**/checks/*.yaml

I will update the create package to generate files in the new recommended layout (this is what we have used for En-ROADS and C-ROADS):

model/
  {model}.mdl
  checks/
    checks.yaml
  comparisons/
    comparisons.yaml

The reason for the extra level of directories is that most projects will eventually have more than one yaml file of each variety, so this is more future-proof.

I will also update the existing sir and hello-world examples to use this recommended file naming and layout.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment