diff --git a/examples/query-playground/README.md b/examples/query-playground/README.md new file mode 100644 index 00000000..f5a5af1f --- /dev/null +++ b/examples/query-playground/README.md @@ -0,0 +1,15 @@ +### Description + +A playground for exploring the DHIS2 API and debugging Data Engine queries and mutations + +#### How to publish + +Since this lives in the repository with the app-runtime library, releasing new versions of this app should be done in a special way to avoid affecting the library's versions: + +1. Add any new changes with `chore` commits +2. Make sure the supported DHIS2 versions are correct in `d2.config.js` +3. Manually update the app version in `package.json` -- **Don't use `yarn version`** because we don't want to a create a git tag for this repo +4. Add a `chore` commit for the version bump in `package.json` (make sure this will get its own commit on `master` and doesn't get squashed with others) +5. Publish the new version to the App Hub + 1. Either on the command line using [`yarn d2-app-scripts publish`](https://developers.dhis2.org/docs/app-platform/scripts/publish/) with an API key you generated on the App Hub + 2. Or by using the "New version" GUI on the App Hub by going to "Your Apps" => "Data Query Playground" => "New Version". This requires access to the DHIS2 organization diff --git a/examples/query-playground/d2.config.js b/examples/query-playground/d2.config.js index 77ac0548..e9aef813 100644 --- a/examples/query-playground/d2.config.js +++ b/examples/query-playground/d2.config.js @@ -2,6 +2,9 @@ const config = { title: 'Data Query Playground', type: 'app', + id: '99d5e87f-4948-4af6-8c0b-727c77235fd1', + minDHIS2Version: '2.32', + entryPoints: { app: './src/App', },