admin-requests icon indicating copy to clipboard operation
admin-requests copied to clipboard

Mark broken

Open Sparks29032 opened this issue 1 year ago • 3 comments

Guidelines for marking packages as broken:

  • We prefer to patch the repo data (see here) instead of marking packages as broken. This alternative workflow makes environments more reproducible.
  • Packages with requirements/metadata that are too strict but otherwise work are not technically broken and should not be marked as such.
  • Packages with missing metadata can be marked as broken on a temporary basis but should be patched in the repo data and be marked unbroken later.
  • In some cases where the number of users of a package is small or it is used by the maintainers only, we can allow packages to be marked broken more liberally.
  • We (conda-forge/core) try to make a decision on these requests within 24 hours.

What will happen when a package is marked broken?

  • Our bots will add the broken label to the package. The main label will remain on the package and this is normal.
  • Our bots will rebuild our repodata patches to remove this package from the repodata.
  • In a few hours after the anaconda.org CDN picks up the new patches, you will no longer be able to install the package from the main channel.

Checklist:

  • [x] I want to mark a package as broken (or not broken):
    • [x] Added a description of the problem with the package in the PR description.
    • [x] Pinged the team for the package for their input.

Want to mark bg_mpl_stylesheets as broken as the correct package name is bg-mpl-stylesheets. We do not want to maintain the misnamed bg_mpl_stylesheets, so we will mark as broken to ensure users do not download this unmaintained version in the future.

ping @conda-forge/bg-mpl-stylesheets

Sparks29032 avatar Jul 17 '24 10:07 Sparks29032

What we usually do here is to add an alias package so bg_mpl_stylesheets depends on bg-mpl-stylesheets and nothing is broken. See these two examples:

  • https://github.com/conda-forge/importlib_metadata-feedstock/blob/main/recipe/meta.yaml
  • https://github.com/conda-forge/typing_extensions-feedstock/blob/main/recipe/meta.yaml

This would result in less confusion for downstream users who had the underscore variant in their environment.yml etc.

jaimergp avatar Jul 17 '24 10:07 jaimergp

Thanks, we will discuss this before deciding whether to close this PR!

Sparks29032 avatar Jul 17 '24 11:07 Sparks29032

I like the solution from @jaimergp if we can do it.

sbillinge avatar Jul 17 '24 11:07 sbillinge