Skip to content

Commit 1da8950

Browse files
authored
Merge pull request #1698 from chicken-biryani/Clear-instructions-
Increases clarity in staging process.
2 parents 6dc35c5 + c0ef8c5 commit 1da8950

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

src/maintainer/adding_pkgs.rst

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,31 @@ The sections below provide detailed instructions on contributing packages to con
1818
The staging process
1919
===================
2020

21-
Getting Started
22-
---------------
21+
The staging process i.e adding a package's recipe has three steps:
22+
23+
#. Generating the recipe
24+
#. Checklist
25+
#. Feedback and revision
2326

24-
There are multiple ways to get started:
27+
Generating the recipe
28+
---------------------
29+
30+
There are, currently, three ways to generate a recipe:
2531

26-
#. Look at `the example recipe <https://github.com/conda-forge/staged-recipes/tree/master/recipes/example>`_ in the `staged-recipes repository <https://github.com/conda-forge/staged-recipes>`_ and modify it as necessary.
2732
#. If it is an R package from `CRAN <https://cran.r-project.org/>`_, kindly
2833
start by using the `conda-forge helper script for R recipes <https://github.com/bgruening/conda_r_skeleton_helper>`_ instead.
2934
Then if necessary, you can make manual edits to the recipe.
3035
#. If it is a python package, you can generate the recipe as a starting point with ``grayskull``.
3136
Use ``conda install -c conda-forge grayskull`` to install ``grayskull``, followed by ``grayskull pypi your_package_name`` to generate the recipe. Note that you do *not* necessarily have to use ``grayskull``, and the
3237
recipes produced by ``grayskull`` might need to be reviewed and edited. Read more about ``grayskull`` and how to use it `here <https://github.com/conda-incubator/grayskull#introduction>`__.
38+
#. If it's none of the above, generate a recipe with the help of `the example recipe <https://github.com/conda-forge/staged-recipes/tree/master/recipes/example>`_ in the `staged-recipes repository <https://github.com/conda-forge/staged-recipes>`_ and modify it as necessary.
3339

3440
Your final recipe should have no comments (unless they're actually relevant to the recipe, and not generic instruction comments), and follow the order in the example.
3541

3642
.. note::
3743

3844
If there are any details you are not sure about please create a pull request anyway. The conda-forge team will review it and help you make changes to it.
3945

40-
4146
In case you are building your first recipe using conda-forge, a step-by-step instruction and checklist that will help you with a successful build is provided below.
4247

4348
.. _staging_steps:
@@ -49,17 +54,18 @@ Step-by-step Instructions
4954
should be downloadable as an archive (.tar.gz, .zip, .tar.bz2, .tar.xz)
5055
or tagged on GitHub, to ensure that it can be verified. (For further
5156
detail, see :ref:`tarballs_no_repos`).
52-
#. Fork the `example recipes
53-
<https://github.com/conda-forge/staged-recipes/tree/master/recipes>`_
54-
repository.
55-
#. Create a new branch from the staged-recipes ``master`` branch.
56-
#. Within your forked copy, generate a new folder in the recipes subdirectory
57-
and copy the `meta.yml
57+
#. Fork and clone the `staged-recipes
58+
<https://github.com/conda-forge/staged-recipes>`_
59+
repository from GitHub.
60+
#. Checkout a new branch from the staged-recipes ``main`` branch.
61+
#. Through CLI, cd inside the 'staged-recipes/recipes' directory.
62+
#. Within your forked copy, create a new folder in the recipes folder for your package (i.e, ``...staged-recipes/recipes/<name-of-package>``)
63+
#. Copy `meta.yaml
5864
<https://github.com/conda-forge/staged-recipes/blob/master/recipes/
59-
example/meta.yaml>`_
60-
file from the example directory. Please leave the example directory
61-
unchanged!
62-
#. Edit the copied recipe (meta.yml) as needed. For details, see
65+
example/meta.yaml>`_ from the example directory.
66+
All the changes in the following steps will happen in the COPIED meta.yaml (i.e., ``...staged-recipes/recipes/<name-of-package>/meta.yaml``).
67+
Please leave the example directory unchanged!
68+
#. Modify the copied recipe (meta.yml) as needed. To see how to modify meta.yaml, take a look at
6369
:ref:`meta_yaml`.
6470
#. Generate the SHA256 key for your source code archive, as described in the
6571
example recipe using the ``openssl`` tool. As an alternative, you can also

0 commit comments

Comments
 (0)