Skip to content

Commit 0e32b37

Browse files
authored
Merge pull request #1786 from ssurbhi560/feedstock-license
2 parents 96c9660 + d2a01c3 commit 0e32b37

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

src/maintainer/adding_pkgs.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,36 @@ Post staging process
110110
* If you want to make a change to the recipe, send a :term:`PR` to the git repository from a fork. Branches of the main repository are used for maintaining different versions only.
111111

112112

113+
.. _feedstock-repository-structure:
114+
115+
Feedstock repository structure
116+
------------------------------
117+
118+
Once the PR containing the recipe for a package is merged in the ``staged-recipes`` repository, a new repository is created automatically called ``<package-name>-feedstock``.
119+
A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configuration files for automatic builds using freely available continuous integration (CI) services.
120+
121+
Each feedstock contains various files that are generated automatically using our automated provisioning tool `conda-smithy <https://github.com/conda-forge/conda-smithy/>`__. Broadly every feedstock has the following files:
122+
123+
recipe
124+
......
125+
126+
This folder contains the ``meta.yaml`` file and any other files/scripts needed to build the package.
127+
128+
LICENSE.txt
129+
............
130+
131+
This file is the license for the recipe itself. This license is different from the package license, which you define while submitting the package recipe using ``license_file`` in the ``meta.yaml`` file.
132+
133+
CI-files
134+
........
135+
136+
These are the CI configuration files for service providers like Azure and TravisCI.
137+
138+
conda-forge.yml
139+
................
140+
141+
This file is used to configure how the feedstock is set up and built. Making any changes in this file usually requires `rerendering the feedstock <https://conda-forge.org/docs/maintainer/updating_pkgs.html#dev-update-rerender>`__.
142+
113143
Maintainer role
114144
---------------
115145

0 commit comments

Comments
 (0)