feat(cli): auto-generate STUDY.json metadata for init and run outputs#504
Open
GaneshPatil7517 wants to merge 3 commits intoControlCore-Project:devfrom
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds automatic generation of a STUDY.json metadata file to improve traceability for studies created via concore init and workflow outputs generated via concore run.
Changes:
- Added a
write_study_metadata(...)helper to generateSTUDY.jsonwith provenance, tool detection, and checksums. - Integrated metadata generation into
concore initandconcore runflows. - Extended CLI and openJupyter security tests to validate metadata creation and ensure required env vars (e.g.,
FLASK_SECRET_KEY) are set in test mode.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
concore_cli/commands/metadata.py |
Introduces the STUDY.json writer (checksums/tool detection/provenance fields). |
concore_cli/commands/init.py |
Calls metadata writer during project initialization and prints metadata info. |
concore_cli/commands/run.py |
Calls metadata writer after workflow generation and prints metadata path. |
tests/test_cli.py |
Adds assertions that STUDY.json is created with expected fields for init/run. |
tests/test_openjupyter_security.py |
Patches required env vars (incl. FLASK_SECRET_KEY) to make security tests reliable. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Author
|
hello @pradeeban the pr is ready to review please review it when you are free.... |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds automatic STUDY.json generation for studies created via concore init and workflow outputs generated via concore run.
The goal is to improve study traceability with lightweight, machine-readable metadata.
What Changed
2.Integrated metadata generation into:
3.Extended CLI tests to verify:
Why
Validation
Local test results:
Compatibility
Fixes #502