Set up examples.yml as metadata file and add workflow to check for discrepancies in pynest examples#3797
Open
jessica-mitchell wants to merge 8 commits intonest:mainfrom
Open
Set up examples.yml as metadata file and add workflow to check for discrepancies in pynest examples#3797jessica-mitchell wants to merge 8 commits intonest:mainfrom
jessica-mitchell wants to merge 8 commits intonest:mainfrom
Conversation
jessica-mitchell
added
T: Enhancement
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
1 participant
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 create a single source of truth for metadata about the
pynest/examplesinexamples.ymland includes workflow that checks it's correctness at pre-release.This file is planned to be used for several downstream workflows and Sphinx scripts.
The idea is that this yml file should be manually updated when there are changes to pynest/examples and a contributor can run the check_examples_registry.py. (instructions added to docs), to check.
But we also run a workflow in nest-simulator that checks for discrepancies between the example files and the yml file at time of pre-release (including more thorough checks). If any change has happened to one but not the other this will cause the workflow to fail.
Changes need to be manually fixed and workflow re-run.
Once the workflow passes, this triggers a downstream repo (nest-simulator-examples) to run.
Currently, the downstream repo workflows still need to be finalized, and the Sphinx extension need to be updated (obviously the file needs to exist first).
this was developed with AI (Claude code)