You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/contracting/00_intro.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
Contracting Information
2
2
#######################
3
3
4
-
If you are interested in a contractual engagement to solve a specific problem that you're facing, this page details the kinds of services that are available to you. ``conda-forge``, as an entity, does not have the ability to engage in a contractual arrangement as of now.
4
+
If you are interested in a contractual engagement to solve a specific problem that you're facing, this page details the kinds of services that are available to you. conda-forge, as an entity, does not have the ability to engage in a contractual arrangement as of now.
5
5
However, there are a number of community members that you may engage with.
6
-
``conda-forge`` does not endorse anyone (individuals or companies) listed on this page.
6
+
conda-forge does not endorse anyone (individuals or companies) listed on this page.
7
7
8
8
9
9
If you are interested in a service that is not listed on this page, please reach out to us on our `issue tracker <https://github.com/conda-forge/conda-forge.github.io/issues>`__, on `Element <https://app.element.io/#/room/#conda-forge:matrix.org>`__ or via emailing the core team directly at [email protected] and we will help to circulate your request more broadly within the community.
@@ -39,7 +39,7 @@ Background / Description: Quansight's goal is to create operational solutions to
39
39
Becoming a Service Provider
40
40
***************************
41
41
42
-
The ``conda-forge`` core team reserves the right to unilaterally update this list at any time for any reason.
42
+
The conda-forge core team reserves the right to unilaterally update this list at any time for any reason.
43
43
If you are a service provider and are interested in being added to this list please open up a pull request against the conda-forge.github.io repository.
44
44
Add yourself to this list and detailing the services you provide.
45
45
Please be brief and link to existing materials on your own website where possible.
Copy file name to clipboardExpand all lines: src/maintainer/adding_pkgs.rst
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ Your final recipe should have no comments (unless they're actually relevant to t
51
51
52
52
.. note::
53
53
54
-
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.
54
+
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.
55
55
56
56
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.
57
57
@@ -96,7 +96,7 @@ Checklist
96
96
97
97
* Ensure that the license and license family descriptors (optional) have the right case and that the license is correct. Note that case sensitive inputs are required (e.g. Apache-2.0 rather than APACHE 2.0). Using SPDX identifiers for license field is recommended. (see :ref:`spdx`)
98
98
* Ensure that you have included a license file if your license requires one -- most do. (see `here <https://github.com/conda-forge/staged-recipes/blob/a504af81c05491bf7b0b018b2fa1efe64767985c/recipes/example/meta.yaml#L52-L55>`_)
99
-
* In case your project has tests included, you need to decide if these tests should be executed while building the ``conda-forge`` feedstock.
99
+
* In case your project has tests included, you need to decide if these tests should be executed while building the conda-forge feedstock.
100
100
* Make sure that all tests pass successfully at least on your development machine.
101
101
* Recommended: run the test locally on your source code to ensure the recipe works locally (see :ref:`staging_test_locally`).
102
102
* Make sure that your changes do not interfere with other recipes that are in the ``recipes`` folder (e.g. the ``example`` recipe).
@@ -121,7 +121,7 @@ Post staging process
121
121
122
122
* After the PR is merged, our :term:`CI` services will create a new git repo automatically. For example, the recipe for a package named ``pydstool`` will be moved to a new repository `https://github.com/conda-forge/pydstool-feedstock <https://github.com/conda-forge/pydstool-feedstock>`_. This process is automated through a CI job on the ``conda-forge/staged-recipes`` repo. It sometimes fails due to API rate limits and will automatically retry itself. If your feedstock has not been created after a day or so, please get in touch with the ``conda-forge/core`` team for help.
123
123
* CI services will be enabled automatically and a build will be triggered automatically which will build the conda package and upload to `https://anaconda.org/conda-forge <https://anaconda.org/conda-forge>`_
124
-
* If this is your first contribution, you will be added to the ``conda-forge`` `team <https://github.com/orgs/conda-forge/people>`_ and given access to the CI services so that you can stop and restart builds. You will also be given commit rights to the new git repository.
124
+
* If this is your first contribution, you will be added to the conda-forge `team <https://github.com/orgs/conda-forge/people>`_ and given access to the CI services so that you can stop and restart builds. You will also be given commit rights to the new git repository.
125
125
* 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.
126
126
127
127
@@ -237,7 +237,7 @@ It defines everything that is required to build and use the package.
237
237
238
238
A full reference of the structure and fields of ``meta.yaml`` file can be found in the `Defining metadata (meta.yaml) <https://conda.io/projects/conda-build/en/stable/resources/define-metadata.html>`__ section in the conda-build documentation.
239
239
240
-
In the following, we highlight particularly important and ``conda-forge`` specific information and guidelines, ordered by section in ``meta.yaml``.
240
+
In the following, we highlight particularly important and conda-forge specific information and guidelines, ordered by section in ``meta.yaml``.
241
241
242
242
243
243
Source
@@ -270,7 +270,7 @@ install the necessary tools below).
270
270
271
271
To generate the ``sha256`` hash: ``openssl sha256 your_sdist.tar.gz``
272
272
273
-
You may need the openssl package, available on ``conda-forge``
273
+
You may need the openssl package, available on conda-forge
274
274
``conda install openssl -c conda-forge``.
275
275
276
276
.. tip::
@@ -403,13 +403,13 @@ For a detailed explanation please refer to the `conda-build documentation <https
403
403
Avoid external dependencies
404
404
...........................
405
405
406
-
As a general rule: all dependencies have to be packaged by ``conda-forge`` as well. This is necessary to assure :term:`ABI` compatibility for all our packages.
406
+
As a general rule: all dependencies have to be packaged by conda-forge as well. This is necessary to assure :term:`ABI` compatibility for all our packages.
407
407
408
408
There are only a few exceptions to this rule:
409
409
410
410
#. Some dependencies have to be satisfied with :term:`CDT` packages (see :ref:`cdt_packages`).
411
411
412
-
#. Some packages require root access (e.g. device drivers) that cannot be distributed by ``conda-forge``. These dependencies should be avoided whenever possible.
412
+
#. Some packages require root access (e.g. device drivers) that cannot be distributed by conda-forge. These dependencies should be avoided whenever possible.
413
413
414
414
415
415
@@ -513,7 +513,7 @@ Sometimes defining tests seems to be hard, e.g. due to:
513
513
- test suites may take too long to run on limited :term:`CI` infrastructure.
514
514
- tests may take too much bandwidth.
515
515
516
-
In these cases, ``conda-forge`` may not be able to execute the prescribed test suite.
516
+
In these cases, conda-forge may not be able to execute the prescribed test suite.
517
517
518
518
However, this is no reason for the recipe to not have tests. At the very least,
519
519
we want to verify that the package has installed the desired files in the desired
Copy file name to clipboardExpand all lines: src/maintainer/conda_forge_yml.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
Configuring conda-forge.yml
2
2
***************************
3
3
4
-
You can configure how ``conda-forge`` is set up and built via the ``conda-forge.yml``
4
+
You can configure how conda-forge is set up and built via the ``conda-forge.yml``
5
5
file that is present in the root directory of a feedstock.
6
6
7
7
Rerendering the feedstock after you modify this file is usually required and always a good idea (see :ref:`dev_update_rerender`).
@@ -165,7 +165,7 @@ Leaving this field empty implicitly requests to build a package natively. i.e.
165
165
166
166
build_with_mambabuild
167
167
---------------------
168
-
This option, when enabled, configures the ``conda-forge`` CI to run a debug build using the ``mamba`` solver. Check `this <https://conda-forge.org/docs/maintainer/maintainer_faq.html#mfaq-mamba-local>`__ to know more.
168
+
This option, when enabled, configures the conda-forge CI to run a debug build using the ``mamba`` solver. Check `this <https://conda-forge.org/docs/maintainer/maintainer_faq.html#mfaq-mamba-local>`__ to know more.
169
169
170
170
.. code-block:: yaml
171
171
@@ -254,7 +254,7 @@ artifacts. The currently supported options are
254
254
conda_forge_output_validation
255
255
-----------------------------
256
256
257
-
This field must be set to ``True`` for feedstocks in the ``conda-forge`` GitHub
257
+
This field must be set to ``True`` for feedstocks in the conda-forge GitHub
258
258
organization. It enables the required feedstock artifact validation as described
259
259
in :ref:`output_validation`.
260
260
@@ -455,7 +455,7 @@ The relative path to the recipe directory. The default is:
455
455
remote_ci_setup
456
456
---------------
457
457
This option can be used to override the default ``conda-forge-ci-setup`` package.
458
-
Can be given with ``${url or channel_alias}::package_name``, defaults to ``conda-forge``
458
+
Can be given with ``${url or channel_alias}::package_name``, defaults to conda-forge
Copy file name to clipboardExpand all lines: src/maintainer/infrastructure.rst
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,13 +9,13 @@ Repositories
9
9
Staging area for recipes
10
10
------------------------
11
11
12
-
`conda-forge/staged-recipes <https://github.com/conda-forge/staged-recipes>`__ is the entry point for new packages to join the ``conda-forge`` package collection.
12
+
`conda-forge/staged-recipes <https://github.com/conda-forge/staged-recipes>`__ is the entry point for new packages to join the conda-forge package collection.
13
13
You can find the detailed guide for submitting new package recipes in :ref:`creating_recipes`.
14
14
15
15
Smithy
16
16
------
17
17
18
-
Smithy contains maintenance code for ``conda-forge``, which is used by the ``conda-smithy`` command line tool and the :ref:`dev_admservice`. Smithy lives in the repository `conda-forge/conda-smithy <https://github.com/conda-forge/conda-smithy>`_.
18
+
Smithy contains maintenance code for conda-forge, which is used by the ``conda-smithy`` command line tool and the :ref:`dev_admservice`. Smithy lives in the repository `conda-forge/conda-smithy <https://github.com/conda-forge/conda-smithy>`_.
19
19
20
20
``conda-forge/conda-smithy`` is the right repository to report bugs for
21
21
@@ -25,15 +25,15 @@ Smithy contains maintenance code for ``conda-forge``, which is used by the ``con
25
25
26
26
``conda-smithy`` also contains the command line tool that you should use if you rerender manually from the command line (see :ref:`dev_update_rerender`).
27
27
28
-
Smithy can be used beyond ``conda-forge``'s purposes. For example, it can be used to `set up self-hosted Azure agents <azure-config>` for non-``conda-forge`` infrastructures.
28
+
Smithy can be used beyond conda-forge's purposes. For example, it can be used to `set up self-hosted Azure agents <azure-config>` for non-conda-forge infrastructures.
29
29
(You could also consider using `Azure virtual machine scale set agents <https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/scale-set-agents?view=azure-devops>`_,
30
30
which could be less expensive to run than permanently active agents.)
31
31
32
32
33
33
Web services
34
34
------------
35
35
36
-
The Heroku app providing the ``conda-forge`` web services lives in `conda-forge/conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`__.
36
+
The Heroku app providing the conda-forge web services lives in `conda-forge/conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`__.
37
37
Please note that the code logic provided by the app is in the ``Smithy`` repository.
38
38
39
39
Bugs or suggestions regarding the service functionality should therefore be opened in ``conda-forge/conda-smithy``'s `bug tracker <https://github.com/conda-forge/conda-smithy/issues>`__.
@@ -43,7 +43,7 @@ conda-forge pinning
43
43
44
44
Package-wide dependency pins are defined in `conda_build_config.yaml <https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/conda_build_config.yaml>`__ in the `conda-forge/conda-forge-pinning-feedstock <https://github.com/conda-forge/conda-forge-pinning-feedstock>`_.
45
45
46
-
For more information on ``conda-forge`` wide package pins, please refer to :ref:`globally_pinned_packages`.
46
+
For more information on conda-forge wide package pins, please refer to :ref:`globally_pinned_packages`.
47
47
48
48
Please open a :term:`PR` and/or an issue there, if you think a pin needs to be advanced. For more information on updating globally pinned packages, please refer to :ref:`update_pins`.
49
49
@@ -63,7 +63,7 @@ If you found any typo error, unclear explanations or new topics that can be cove
63
63
Admin web services
64
64
==================
65
65
66
-
``conda-forge`` is running a webservice on Heroku called `conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
66
+
conda-forge is running a webservice on Heroku called `conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
67
67
68
68
The following services are run by default on a feedstock:
69
69
@@ -117,14 +117,14 @@ all of the CI builds to restart.
117
117
------------------------------------
118
118
119
119
Entering this command in the PR of a feedstock or staged-recipes will have the admin bot @-mention the team
120
-
associated with the repo. This command can be useful for people who are not yet members of ``conda-forge`` and
120
+
associated with the repo. This command can be useful for people who are not yet members of conda-forge and
121
121
so cannot @-mention the ``staged-recipes`` team for PR reviews.
0 commit comments