Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor branchline template depo #272

Open
ayushuk opened this issue Mar 1, 2023 · 0 comments
Open

Refactor branchline template depo #272

ayushuk opened this issue Mar 1, 2023 · 0 comments
Assignees
Labels
branchline This issue is part of branchline development

Comments

@ayushuk
Copy link
Member

ayushuk commented Mar 1, 2023

In an effort to organize templates on branchline, the repo will follow a new organization of template information. Currently the the pros-mainline contains a single JSON file with template information including name, zip location, version, supported kernel version and more:

{
"metadata": {
"location": "https://pros.cs.purdue.edu/v5/_static/releases/[email protected]"
},
"name": "kernel",
"py/object": "pros.conductor.templates.base_template.BaseTemplate",
"supported_kernels": null,
"target": "v5",
"version": "3.5.2"
},

This information is all the CLI needs to locate and download the zip file of the template. Branchline requires more information about a template such as author, README for description and additional features such as tags to better identify templates. To handle scalability of the branchline repo each template will have its own JSON file for different versions of the template. This means that the main JSON file listing all the different templates only has basic information:

{
"metadata": {
"location": "link to a secondary json (below)"
},
"name": "template name",
"py/object": "some new python class",
"target": "v5",
"tags": "python list for vsc"
},

It will link to a child (secondary) JSON file which has more version specific information including a link to the zip file of the template:

{
"metadata": {
"location": "actual zip link"
},
"name": "template name",
"py/object": "some new python object",
"supported_kernels": '["3.5.1", "3.5.2"]',
"version": "3.5.2",
"author": "sigbots",
"organization" : "sigbots",
"readme" : "link to markdown file, belongs to author of template"
},

Note that on release of branchine both kernel and okapilib will be primarily accessed from the branchline depo so they will be refactored into this format.

Refer to the branchline design doc for more information.

@ayushuk ayushuk changed the title Make new JSON files in pros-branchline repo following the new JSON format Refactor branchline template depo Mar 1, 2023
@ayushuk ayushuk added the branchline This issue is part of branchline development label Mar 1, 2023
@ayushuk ayushuk self-assigned this Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branchline This issue is part of branchline development
Projects
None yet
Development

No branches or pull requests

1 participant