-
Notifications
You must be signed in to change notification settings - Fork 31
CEP XXXX: Contents of conda packages #133
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
base: main
Are you sure you want to change the base?
Conversation
soapy1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting this together!
|
|
||
| This file MUST conform to the following schema: | ||
|
|
||
| - `name: str`. Lowercased name of the package. It MUST comply with [CEP 26](./cep-0026.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be good to denote which of these fields are required and which are optional. A format for this could be like
`name: str`. Required. . . .
Might also be worth it to split this into it's own cep?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've used "required unless stated otherwise" throughout the CEP, but maybe I can call that explicitly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What part do you want to split in its own CEP? index.json? The info/ folder?
cep-XXXX.md
Outdated
|
|
||
| ## Specification | ||
|
|
||
| An extracted conda package is a directory that MUST at least include an `info/index.json` file. Other important metadata files SHOULD be included under `info/`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Later on the document notes that ./info/paths.json and ./info/hash_input.json are also required. So, those should probably be mentioned here as well as part of this "MUST at least include"
| An extracted conda package is a directory that MUST at least include an `info/index.json` file. Other important metadata files SHOULD be included under `info/`. | |
| An extracted conda package is a directory that MUST at least include `info/index.json`, `./info/paths.json` and `./info/hash_input.json` files. Other important metadata files SHOULD be included under `info/`. |
|
|
||
| Optional. | ||
|
|
||
| If the package sources come from a `git` repository and the `git` executable is available, this file will include information about the status of the cloned repository. Namely, the output of: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a stict requirement for the format of this file? Is it valid if the file exists but is empty?
Co-authored-by: Sophia Castellarin <scastellarin@openteams.com>
Checklist for submitter
cep-0000.mdnamedcep-XXXX.mdin the root level.Checklist for CEP approvals
${greatest-number-in-main} + 1.cep-XXXX.mdfile has been renamed accordingly.# CEP XXXX -header has been edited accordingly.pre-commitchecks are passing.Closes Quansight-Labs/conda-ecosystem-sta-mgmt#32