diff --git a/news/release_schemas.rst b/news/release_schemas.rst new file mode 100644 index 000000000..c25222e1e --- /dev/null +++ b/news/release_schemas.rst @@ -0,0 +1,23 @@ +**Added:** + +* Added release_list schemas in `schemas.json`. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/src/regolith/exemplars.json b/src/regolith/exemplars.json index 6baf0fd6f..b788e10b1 100644 --- a/src/regolith/exemplars.json +++ b/src/regolith/exemplars.json @@ -2169,6 +2169,49 @@ "year": 2020 } ], + "releaseReports": [ + { + "_id": "sbillinge", + "date": "17/07/2025", + "releases": [ + { + "package_name": "regolith", + "description": "A Group Content Management System", + "url": "https://github.com/regro/regolith", + "release_updates": [ + { + "version_number": "0.9.1", + "updated_capacities": ["Rearrange Regolith package to new Billingegroup package standards", + "change name and then fix tests for function that formats awards and honors"], + "release_url": "https://github.com/regro/regolith/releases/tag/0.9.1", + "release_date": "21/07/2024", + "author": ["Simon Billinge", "Rundong Hua"], + "author_id": ["sbillinge", "stevenhua0320"] + }, + { + "version_number": "0.8.1", + "updated_capacities": "Fix bug in builder", + "release_date": "11/13/2023", + "author": "Simon Billinge", + "author_id": "sbillinge" + }] + }, + { + "package_name": "diffpy.xpdfsuite", + "description": "The suite of algorithms and software for diffpy programs.", + "release_updates": [ + { + "version_number": "0.2.0", + "updated_capacities": "scikit-pakcage everything in the suite to new BillingeGroup standard.", + "release_date": "20/10/2025", + "author": ["Simon Billinge", "Zhiming Xu", "Rundong Hua"], + "author_id": ["sbillinge", "zmx27", "stevenhua0320"] + } + ] + } + ] + } + ], "students": { "_id": "Human A. Person", "aka": ["H. A. Person"], diff --git a/src/regolith/schemas.json b/src/regolith/schemas.json index f2468a87c..240a72f66 100644 --- a/src/regolith/schemas.json +++ b/src/regolith/schemas.json @@ -2924,6 +2924,109 @@ "anyof_type": ["string", "integer"] } }, + "releaseReports": { + "_description": { + "description": "This is a collection of information that will be be used to build a release report. This should probably be private." + }, + "_id": {"description": "the ID", "required": true, "type": "string"}, + + "date": { + "description": "date the list was edited", + "required": false, + "anyof_type": ["date", "string"] + }, + "day": { + "description": "The day the list was edited", + "required": false, + "type": "integer" + }, + "month": { + "description": "The month the list was edited", + "required": false, + "anyof_type": ["integer", "string"] + }, + "year": { + "description": "The day the list was edited", + "required": false, + "type": "integer" + }, + "released_package": { + "description": "The list of software releases.", + "required": true, + "type": "list", + "schema": { + "type": "dict", + "schema": { + "package_name": { + "description": "the name of the package.", + "required":true, + "type": "string" + }, + "description": { + "description": "the description of what is the software doing.", + "required": true, + "type": "string" + }, + "url": { + "description": "the url of the released software if it is public.", + "required": false, + "type": "string" + }, + "release_updates": { + "description": "updated/added capacities for each time of release.", + "required": true, + "type": "list", + "schema": { + "type": "dict", + "schema": { + "version_number": { + "description": "The version number of the package.", + "required": true, + "type": "string" + }, + "updated_capacities": { + "description": "the description of the updated capacity of the package.", + "required": true, + "type": "string" + }, + "release_url": { + "description": "the released url of the package in specific version.", + "required": false, + "type": "string" + }, + "release_year": { + "description": "the year of the version released.", + "required": true, + "type": "integer" + }, + "release_month": { + "description": "the month of the version released.", + "required": true, + "anyof_type": ["integer", "string"] + }, + "release_day": { + "description": "the day of the version released.", + "required": true, + "type": "integer" + }, + "author": { + "description": "the author(s) who contribued to the version release.", + "required": true, + "anyof_type": ["list", "string"] + }, + "author_id": { + "description": "the id of the author who contributed to the version release.", + "required": false, + "anyof_type": ["list", "string"] + } + } + + } + } + } + } + } + }, "software": { "_description": {"description": "Information about software, such as active, grants, etc."}, "_id": {