Generating new schema for v1.9.0 #83
Conversation
…in the github workflow whenever a new schema is introduced in the schema folder
erdalkaraca
changed the title
|
|
||
| - name: Run generatemodel.py | ||
| run: | | ||
| python ancpbids/generatemodel.py --schema-file ${{ steps.get_version.outputs.schema_file }} --version-tag ${{ steps.get_version.outputs.version_tag }} |
There was a problem hiding this comment.
it seems you added support for parameters but the generatemodel.py has no changes in this commit: please make sure you also commit the changes to generatemodel.py... please also make sure that the path to the generatemodel.py is correct, i.e. should be ancpbids/tools/generatemodel.py
| on: | ||
| push: | ||
| paths: | ||
| - 'schema/*.json' # Triggers only when a new schema JSON file is added or modified |
There was a problem hiding this comment.
so, an ancpBIDS dev would have to copy a new schema.json from the BIDS spec repo over to ancpBIDS, push to main, then this action/workflow will be triggered?
There was a problem hiding this comment.
Yes, since i copied the new schema.json file to the schema and ran it, i thought that can be trigger point.
|
|
||
| - name: Update version_tag in generatemodel.py | ||
| run: | | ||
| sed -i "s/version_tag = 'v[0-9]\+\.[0-9]\+\.[0-9]\+'/version_tag = '${{ steps.get_version.outputs.version_tag }}'/" ancpbids/generatemodel.py |
There was a problem hiding this comment.
you already parameterized the script, just use the parameter --version-tag in the script instead of changing it inside
There was a problem hiding this comment.
I modified the code just to use the version_tag. But i saw that the workflow still failed in some tests. Should i push the changes or would you like to review it once?
There was a problem hiding this comment.
yes, please push the changes to your pul lrequest
|
after thinking a bit more about the process, it might be better to integrate the automation directly into the generatemode.py script: This would download the schema.json file from the appropriate branch in the BIDS repo and save it as schema-{version_tag}.json in the schema/ folder. Then call the existing code to generate a new python model for the downloaded schema. |
… schema folder, download it and run the script without manually updating the version.
tools/generatemodel.py
Outdated
|
|
||
|
|
||
| # Function to fetch the latest schema version from GitHub | ||
| def fetch_latest_schema_version(): |
There was a problem hiding this comment.
it may be better to parameterize this function to allow a specific version to be generated and only generate the latest version if the parameter is not set:
def fetch_schema_version(version_tag=None): ...
There was a problem hiding this comment.
and also make sure, the user provided a version_tag >= 1.8.0 as the schema.json was only introduced beginning with 1.8.0
tools/generatemodel.py
Outdated
| module_version_tag = version_tag.replace('.', '_') | ||
| generator = ClassGenerator("../schema/model_base.yaml", f"../schema/schema_{version_tag}.json", module_version_tag) | ||
| generator.generate(version_tag) | ||
| # Fetch the latest schema version and URL |
There was a problem hiding this comment.
re-introduce arg parser to allow providing a specific schema version to be generated
|
So far, I like your approach to download the schema.json! When running the test suite, two tests regarding the schema loading fail: please try to understand why they are failing and maybe come up with a fix. |
…schema_version(): to allow a specific version to be generated and only generate the latest version if the parameter is not set , Changed test_schema.py script to accomodate new version v1.9.0
New schema_v1.9.0 is run with generatemodel.py and the new output file model_v1.9.0.py has been generated . Changes has been compared .