Skip to content

Commit

Permalink
Update labels in CFEP 5 to align with survey results
Browse files Browse the repository at this point in the history
The original CFEP 5 had the labels as rc_package and dev_package. During
the discussionof CFEP 5 (conda-forge#3), a
discussion and survey ensued about whether the prerelease indicators
should be before the package name or after:

conda-forge#3 (comment)

The results were that the prerelease indicators should be after, but the
text of the CFEP was never updated. This commit updates the CFEP.
  • Loading branch information
jasongrout committed Feb 6, 2020
1 parent fb2f342 commit 17b51b0
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions cfep-05.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<tr><td> Status </td><td> Accepted </td></tr>
<tr><td> Author(s) </td><td> Eric Dill &lt;[email protected]&gt;</td></tr>
<tr><td> Created </td><td> Sept 09, 2016</td></tr>
<tr><td> Updated </td><td> Oct 18, 2019</td></tr>
<tr><td> Updated </td><td> Feb 5, 2020</td></tr>
<tr><td> Discussion </td><td> NA </td></tr>
<tr><td> Implementation </td><td> NA </td></tr>
</table>
Expand All @@ -30,7 +30,7 @@ The same semantics are slightly more cumbersome within the Conda ecosystem but
are still manageable. The analogous command with `conda` is (for example):

```
conda install -c conda-forge/label/rc_matplotlib matplotlib
conda install -c conda-forge/label/matplotlib_rc matplotlib
```

We, as the conda-forge community need to arrive at a consensus for what labels
Expand Down Expand Up @@ -63,28 +63,28 @@ See the Appendix for dev and rc version order specifics.

To create a `dev` or `rc` package a PR can be issued into the `dev` or `rc` branch of the
feedstock.
This branch must change the `recipe/conda_build_config.yaml` to point to the `dev_<package_name>` or `rc_<package_name>` label.
This branch must change the `recipe/conda_build_config.yaml` to point to the `<package_name>_dev` or `<package_name>_rc` label.

For example, matplotlib rc releases would include:
```yaml
...
channel_targets:
- conda-forge rc_matplotlib
- conda-forge matplotlib_rc
```
If a pre-release build of B depends on a pre-release build of A, then A should have,
```yaml
...
channel_targets:
- conda-forge rc_A
- conda-forge A_rc
```
while B should have,
```yaml
...
channel_sources:
- conda-forge/label/rc_A,conda-forge,defaults
- conda-forge/label/A_rc,conda-forge,defaults
channel_targets:
- conda-forge rc_B
- conda-forge B_rc
```
in `recipe/conda_build_config.yaml` in their respective feedstocks.

Expand Down Expand Up @@ -124,7 +124,7 @@ conda install -c conda-forge/label/LABEL_PACKAGE_NAME -c conda-forge PACKAGE_NAM
For example, let's install matplotlib from the "rc" label:

```
conda install -c conda-forge/label/rc_matplotlib -c conda-forge matplotlib
conda install -c conda-forge/label/matplotlib_rc -c conda-forge matplotlib
```

## Work Items
Expand All @@ -138,6 +138,14 @@ conda install -c conda-forge/label/rc_matplotlib -c conda-forge matplotlib

This is tracked in https://github.com/conda-forge/conda-forge-ci-setup-feedstock/issues/66

## Updates

- Feb 5, 2020: The labels were changed to put the dev/rc indication after the
package name rather than before, i.e., `<package_name>_dev` and
`<package_name>_rc` instead of `dev_<package_name>` and `rc_<package_name>`,
respectively. This aligns with the conclusions of the survey and discussion
during the approval process for this CFEP.

## Appendix

If you wish to add numbers to your "dev" or "rc" you should follow the
Expand Down

0 comments on commit 17b51b0

Please sign in to comment.