Skip to content

Conversation

@jaimergp
Copy link
Contributor

@jaimergp jaimergp commented Sep 27, 2025

Checklist for submitter

  • I am submitting a new CEP: Contents of conda packages.
    • I am using the CEP template by creating a copy cep-0000.md named cep-XXXX.md in the root level.
  • I am submitting modifications to CEP XX.
  • Something else: (add your description here).

Checklist for CEP approvals

  • The vote period has ended and the vote has passed the necessary quorum and approval thresholds.
  • A new CEP number has been minted. Usually, this is ${greatest-number-in-main} + 1.
  • The cep-XXXX.md file has been renamed accordingly.
  • The # CEP XXXX - header has been edited accordingly.
  • The CEP status in the table has been changed to approved.
  • The last modification date in the table has been updated accordingly.
  • The table in the README has been updated with the new CEP entry.
  • The pre-commit checks are passing.

Closes Quansight-Labs/conda-ecosystem-sta-mgmt#32

Copy link

@soapy1 soapy1 left a 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).
Copy link

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?

Copy link
Contributor Author

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.

Copy link
Contributor Author

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/`.
Copy link

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"

Suggested change
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:
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CEP: Package contents and info/ folder

2 participants