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.

Sign up for GitHub

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

Jump to bottom

extend conda forge related docs #2352

Merged
merged 2 commits into from
Jun 5, 2024
Merged

extend conda forge related docs #2352

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
501cffb
extend conda forge related docs
OriolAbril Jun 4, 2024
7d73267
add links to relevant conda forge repos
OriolAbril Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions doc/source/contributing/how_to_release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,26 @@ ArviZ uses the following process to cut a new release of the library.
```

9. If the versions were updated in step 3, update also the [conda forge recipe](https://github.com/conda-forge/arviz-feedstock).

:::{important}
There is a bot that opens a PR automatically to update the conda forge recipe.
However, **all dependencies must be checked manually** to ensure the ones in
the recipe match those in the requirements
:::

10. (here for reference but we really want to avoid it) If for some reason there were an issue
with a release, there are two tools to fix it in conda forge:

* repodata patch: If there is a new release for one of the dependencies with breaking changes
for example, a repodata patch should be submitted to conda forge to prevent users
from installing a broken environment.

Repodata patches are submitted to [conda-forge/conda-forge-repodata-patches-feedstock](https://github.com/conda-forge/conda-forge-repodata-patches-feedstock)
* mark a build as broken: If the dependencies were incorrect in the recipe, then the existing
build should be marked as broken and a PR (completely manual) should be submitted
to the arviz-feedstock to fix the recipe. Note that if this is being done for a release
different than the latest, changes should not be merged into `main` but on a dedicated
branch, the conda-forge package build is generated all the same but the history is kept
tidier and prevents issues when a new release is published.

Requests to mark packages as broken are submitted to [conda-forge/admin-requests](https://github.com/conda-forge/admin-requests/)