Notes from code review with @julesghub

[dansand]

Code review

Summary

Dan walked Julian through the code base (https://github.com/ModelAtlasofTheEarth/Model_Submission/tree/main/.github/scripts), describing the model submission workflow and data structures. Tim discussed the github actions, and gave an overview of how the tokens/bots work.

• Overall Julian was positive about the work we have done. No major refactoring was suggested, however there is work to be done to get the code into a state where it could be understood/developed by a third party.

Key Tasks:

Create workflow diagrams:

• Dan to create a diagram to document the model submission workflow functionality
• Tim to create a diagram to document permissions, API keys

Additional comments/tasks

• duplication between the strings used in the issue template, and the strings (dictionary keys) used in parse_issue. We discussed work arounds via a mapping (perhaps using a unique id ), that would us to update the names used in both places, and potentially allow for different names to be used. This task is not a high priority.
• replace actions bot with M@TE bot (M@TEY, or old M@TE) (its the token used that sets which bot is used)
• Separate scripts related to data parsing API calls, and those related to github actions, like creating new repos, copying files.
• In write_repo_contents, we can still break out some of the code into external functions, like the writing of the YAML and and the report into the Readme.md
• some old files to get rid of (e.g. metadata_V2.json)
• put csv files in resources/assets folder
• Consider utilizing versions of the template repos
• in the following, change to "model created, gh api --method=POST "repos/${OWNER}/${REPO_NAME}/labels" -f name='published' -f description='Model published' -f color=B93BCB
• "model created" not appearing on the issue, after repo. is created
• Make the code robust in terms of whether certain comments on the initial issue are present