add designated users (#28)

CDCgov · Nov 12, 2024 · 9d7383f · 9d7383f
1 parent 1119fdb
commit 9d7383f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/hub-config/model-metadata-schema.json b/hub-config/model-metadata-schema.json
@@ -109,6 +109,13 @@
         "ensemble_of_hub_models": {
             "description": "Indicator for whether this model is an ensemble of other models submitted to this Hub",
             "type": "boolean"
+        },
+        "designated_github_users": {
+            "description": "Team member(s) who would be responsible for submitting forecasts as a pull request to the CovidHub repository. Only the pull request from users specified here can get merged automatically after validation.",
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
         }
     },
     "additionalProperties": false,

diff --git a/model-metadata/README.md b/model-metadata/README.md
@@ -118,6 +118,20 @@ Any information about funding source(s) for the team or members of the team that
 team_funding: "National Institutes of General Medical Sciences (R01GM123456). The content is solely the responsibility of the authors and does not necessarily represent the official views of NIGMS."
 ```
 
+### `designated_github_users`
+
+GitHub user ids of team members who would be responsible for submitting forecasts as a pull request to the CovidHub repository. Only the pull request from users specified here can get merged automatically after validation. Example:
+```
+designated_github_users: [
+  "dependabot",
+  "octocat"
+]
+```
+or 
+```
+designated_github_users: ["dependabot"]
+```
+
 # Metadata validation
 
 Optionally, you may validate a model metadata file locally before submitting it to the hub in a pull request. Note that this is not required, since the validations will also run on the pull request, but it is encouraged. To run validations locally, follow these steps: