From 420ab08aab07609a889ffc8094a5ac618e138945 Mon Sep 17 00:00:00 2001 From: Shloka gupta Date: Sat, 9 Apr 2022 05:57:19 +0530 Subject: [PATCH 1/3] Make the steps clearer. --- src/maintainer/adding_pkgs.rst | 37 ++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/src/maintainer/adding_pkgs.rst b/src/maintainer/adding_pkgs.rst index b53bf80086..9f35690356 100644 --- a/src/maintainer/adding_pkgs.rst +++ b/src/maintainer/adding_pkgs.rst @@ -18,18 +18,24 @@ The sections below provide detailed instructions on contributing packages to con The staging process =================== -Getting Started ---------------- +The staging process i.e adding a package's recipe has three steps: + +#. Generating the recipe +#. Checklist +#. Feedback and revision -There are multiple ways to get started: +Generating the recipe +--------------------- + +There are, currently, three ways to generate a recipe: -#. Look at `the example recipe `_ in the `staged-recipes repository `_ and modify it as necessary. #. If it is an R package from `CRAN `_, kindly start by using the `conda-forge helper script for R recipes `_ instead. Then if necessary, you can make manual edits to the recipe. #. If it is a python package, you can generate the recipe as a starting point with ``grayskull``. 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 recipes produced by ``grayskull`` might need to be reviewed and edited. Read more about ``grayskull`` and how to use it `here `__. +#. If it's none of the above, generate a recipe with the help of `the example recipe `_ in the `staged-recipes repository `_ and modify it as necessary. 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. @@ -37,7 +43,6 @@ Your final recipe should have no comments (unless they're actually relevant to t 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. - 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. .. _staging_steps: @@ -49,17 +54,19 @@ Step-by-step Instructions should be downloadable as an archive (.tar.gz, .zip, .tar.bz2, .tar.xz) or tagged on GitHub, to ensure that it can be verified. (For further detail, see :ref:`tarballs_no_repos`). -#. Fork the `example recipes - `_ - repository. -#. Create a new branch from the staged-recipes ``master`` branch. -#. Within your forked copy, generate a new folder in the recipes subdirectory - and copy the `meta.yml +#. Fork and clone the `staged-recipes + `_ + repository from GitHub. +#. Checkout a new branch from the staged-recipes ``main`` branch. +#. Through CLI, cd inside the 'staged-recipes/recipes' directory. +#. Within your forked copy, create a new folder in the recipes folder, for your package. ``...staged-recipes/recipes/`` +#. Copy `meta.yml `_ - file from the example directory. Please leave the example directory - unchanged! -#. Edit the copied recipe (meta.yml) as needed. For details, see + example/meta.yaml>`_ from the example directory. + All the changes in the following steps will happen in the COPIED meta.yaml i.e + ``...staged-recipes/recipes//meta.yaml`` + Please leave the example directory unchanged! +#. Modify the copied recipe (meta.yml) as needed. To see how to modify meta.yaml take a look at :ref:`meta_yaml`. #. Generate the SHA256 key for your source code archive, as described in the example recipe using the ``openssl`` tool. As an alternative, you can also From 257a21d29df80585568926467b103298779ca10e Mon Sep 17 00:00:00 2001 From: Shloka gupta Date: Thu, 14 Apr 2022 22:35:44 +0530 Subject: [PATCH 2/3] Fixes. --- src/maintainer/adding_pkgs.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/maintainer/adding_pkgs.rst b/src/maintainer/adding_pkgs.rst index 9f35690356..bf3fa639e7 100644 --- a/src/maintainer/adding_pkgs.rst +++ b/src/maintainer/adding_pkgs.rst @@ -59,14 +59,13 @@ Step-by-step Instructions repository from GitHub. #. Checkout a new branch from the staged-recipes ``main`` branch. #. Through CLI, cd inside the 'staged-recipes/recipes' directory. -#. Within your forked copy, create a new folder in the recipes folder, for your package. ``...staged-recipes/recipes/`` +#. Within your forked copy, create a new folder in the recipes folder for your package (i.e, ``...staged-recipes/recipes/``) #. Copy `meta.yml `_ from the example directory. - All the changes in the following steps will happen in the COPIED meta.yaml i.e - ``...staged-recipes/recipes//meta.yaml`` + All the changes in the following steps will happen in the COPIED meta.yaml (i.e., ``...staged-recipes/recipes//meta.yaml``). Please leave the example directory unchanged! -#. Modify the copied recipe (meta.yml) as needed. To see how to modify meta.yaml take a look at +#. Modify the copied recipe (meta.yml) as needed. To see how to modify meta.yaml, take a look at :ref:`meta_yaml`. #. Generate the SHA256 key for your source code archive, as described in the example recipe using the ``openssl`` tool. As an alternative, you can also From c0ef8c5dd1ca4af9af824ed5c7718d56904d284e Mon Sep 17 00:00:00 2001 From: Shloka Date: Tue, 19 Apr 2022 01:53:36 +0530 Subject: [PATCH 3/3] Update src/maintainer/adding_pkgs.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jaime Rodríguez-Guerra --- src/maintainer/adding_pkgs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/maintainer/adding_pkgs.rst b/src/maintainer/adding_pkgs.rst index bf3fa639e7..8068f71aeb 100644 --- a/src/maintainer/adding_pkgs.rst +++ b/src/maintainer/adding_pkgs.rst @@ -60,7 +60,7 @@ Step-by-step Instructions #. Checkout a new branch from the staged-recipes ``main`` branch. #. Through CLI, cd inside the 'staged-recipes/recipes' directory. #. Within your forked copy, create a new folder in the recipes folder for your package (i.e, ``...staged-recipes/recipes/``) -#. Copy `meta.yml +#. Copy `meta.yaml `_ from the example directory. All the changes in the following steps will happen in the COPIED meta.yaml (i.e., ``...staged-recipes/recipes//meta.yaml``).