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

Standardise name of top-level config files #490

Open
alexdewar opened this issue Aug 13, 2024 · 1 comment · May be fixed by #519
Open

Standardise name of top-level config files #490

alexdewar opened this issue Aug 13, 2024 · 1 comment · May be fixed by #519

Comments

@alexdewar
Copy link
Contributor

At present, users can choose whatever name they like for the config file (though generally we are using names ending in *Config.json). The whole path to this config file is passed to HealthGPS when we start it. This is in contrast to the top-level JSON file for static data, which is always called index.json.

The problem is that if we want to implement #406, there will be no way for HGPS to know what the name of the top-level config file is inside a zip file. We could also require users to pass in the filename separately, but this seems a bit gross.

It might be best just to standardise the filename (e.g. to config.json). We could do this in a backwards compatible way: if users pass in the path to a JSON file that is called something else, we could just give them a deprecation warning.

Am I missing anything @jamesturner24? One downside of this approach is that it will no longer be possible to have multiple top-level config files in the same directory (well, without using deprecated functionality, anyway).

@jamesturner246
Copy link
Contributor

Having one and only one config with standard name sounds great. Long as we can have many sub config files. If people want to have many toplevel configs in their dir, then they can make symlinks. I'm in favour of this.

alexdewar added a commit that referenced this issue Sep 11, 2024
alexdewar added a commit that referenced this issue Sep 11, 2024
@alexdewar alexdewar linked a pull request Sep 11, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

Successfully merging a pull request may close this issue.

2 participants