|
1 | 1 | Release Process
|
2 | 2 | ===============
|
3 | 3 |
|
4 |
| -This document aims to outline the steps needed to release the ``openff-evaluator`` on ``omnia``. This |
| 4 | +This document aims to outline the steps needed to release the ``openff-evaluator`` on ``conda-forge``. This |
5 | 5 | should only be done with the approval of the core maintainers.
|
6 | 6 |
|
7 | 7 | 1. Update the Release History
|
@@ -70,37 +70,30 @@ To cut a new release on GitHub:
|
70 | 70 |
|
71 | 71 | *Note - You do not need to upload any files. The source code will automatically be added as a `.tar.gz` file.*
|
72 | 72 |
|
73 |
| -3: Trigger a New Build on Omnia |
74 |
| -------------------------------- |
| 73 | +3: Trigger a New Build on Conda Forge |
| 74 | +------------------------------------- |
75 | 75 |
|
76 |
| -To trigger the build in ``omnia``: |
| 76 | +To trigger the build on ``conda-forge``: |
77 | 77 |
|
78 |
| -1) Create branch or fork of omnia-md/conda-recipes with the following changes to openff-evaluator in |
79 |
| -`meta.yaml <https://github.com/omnia-md/conda-recipes/blob/master/openff-evaluator/meta.yaml>`_: |
| 78 | +1) Create a fork of the `openff-evaluator-feedstock <https://github.com/conda-forge/openff-evaluator-feedstock>`_ and |
| 79 | +make the following changes to the ``recipe/meta.yaml`` file: |
80 | 80 |
|
81 |
| - a) Set ``git_tag`` to match the git release tag |
82 |
| - b) Update the ``version`` to match the release (this will go into the conda package name) |
83 |
| - c) Set ``build`` to 0 |
84 |
| - d) Update any dependencies in the ``requirements`` section |
85 |
| - e) If we want to push to special ``rc`` label use ``extra.upload`` |
| 81 | + a) Update the ``version`` to match the release. |
| 82 | + b) Set ``build`` to 0 |
| 83 | + c) Update any dependencies in the ``requirements`` section |
| 84 | + d) Update the sha256 hash to the output of ``curl -sL https://github.com/openforcefield/openff-evaluator/archive/{{ version }}.tar.gz | openssl sha256`` |
86 | 85 |
|
87 |
| -2) Open PR to merge branch or fork into omnia-md master: |
| 86 | +2) Open PR to merge the fork into the main feedstock: |
88 | 87 |
|
89 |
| - a) The PR title should have the format ``[openff-evaluator] X.Y.Z (label: rc)`` |
| 88 | + a) The PR title should have the format ``Release X.Y.Z`` |
90 | 89 | b) No PR body text is needed
|
91 |
| - c) Travis will run on this PR (~30 minutes) and attempt to build the package. Under no conditions will the package |
92 |
| - be uploaded before the PR is merged. This step is just to ensure that building doesn't crash. |
93 |
| - d) If the build is successful the PR should be reviewed and merged by the ``omnia`` maintainers |
94 |
| - e) **Once merged into master** the package is built again on travis, and pushed to the channel set in |
95 |
| - meta.yaml (``main``, ``beta``, or ``rc``) |
| 90 | + c) The CI will run on this PR (~30 minutes) and attempt to build the package. |
| 91 | + d) If the build is successful the PR should be reviewed and merged by the feedstock maintainers. |
| 92 | + e) **Once merged** the package is built again on and uploaded to anaconda. |
96 | 93 |
|
97 |
| -3) Test the ``omnia`` package: |
| 94 | +3) Test the ``conda-forge`` package: |
98 | 95 |
|
99 |
| - a) ``conda install -c omnia openff-evaluator`` |
100 |
| - |
101 |
| -*Note: Omnia builds take about 30 minutes to run. When you open a PR the build will run, and you can check the bottom |
102 |
| -of the travis logs for "package failed to build" listings. Some packages always fail (protons, assaytools), but |
103 |
| -``openff-evaluator`` shouldn't be there. Ctrl-F for ``openff-evaluator`` to ensure that it did build at all though.* |
| 96 | + a) ``conda install -c conda-forge openff-evaluator`` |
104 | 97 |
|
105 | 98 | 4: Update the ReadTheDocs Build Versions
|
106 | 99 | --------------------------------------------
|
|
0 commit comments