Skip to content

Commit df804a4

Browse files
authored
Merge pull request #1382 from bashirk/patch-1
Updated infrastructure.rst
2 parents 257b9d6 + 4ea6cba commit df804a4

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

src/maintainer/infrastructure.rst

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can find a detailed guide to submitting new package recipes in :ref:`creatin
1515
Smithy
1616
------
1717

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>`_.
1919

2020
``conda-forge/conda-smithy`` is the right repository to report bugs for
2121

@@ -41,12 +41,12 @@ Package-wide dependency pins are defined in `conda_build_config.yaml <https://gi
4141

4242
For more information on conda-forge wide package pins, please refer to :ref:`globally_pinned_packages`.
4343

44-
Please open a :term:`PR` and/or issues there if you think a pin needs to be advanced. For more information on updating globally pinned packages, please refer to :ref:`update_pins`.
44+
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`.
4545

4646
Documentation
4747
-------------
4848

49-
The documentation lives in `conda-forge/conda-forge.github.io <https://github.com/conda-forge/conda-forge.github.io/>`__ and is automatically deployed to our `online version <https://conda-forge.org/docs/>`__.
49+
The documentation lives in `conda-forge/conda-forge.github.io <https://github.com/conda-forge/conda-forge.github.io/>`__, and is automatically deployed to our `online version <https://conda-forge.org/docs/>`__.
5050

5151
The documentation is built with ``Sphinx`` and the sources files are located in the `src <https://github.com/conda-forge/conda-forge.github.io/tree/master/src>`__ directory of the repository.
5252

@@ -64,30 +64,30 @@ Conda-forge is running a webservice on Heroku called `conda-forge-webservices <h
6464
The following services are run by default on a feedstock:
6565

6666
- It will lint the recipes in the PRs and report back whether the recipe is in excellent condition or not.
67-
- When maintainers are added to a recipe, the maintainer will be added to the team and given push access.
67+
- When maintainers are added to a recipe, each of the maintainers will be added to the team and given push access to the feedstock.
6868

69-
The webservice also listens to issue and PR comments so that you can ask for the following services to be done.
69+
The webservice also listens to issues and PR comments, so that you can ask for the following services to be done:
7070

7171
@conda-forge-admin, please rerender
7272
-----------------------------------
7373

7474
Entering the above phrase in a PR of a feedstock will rerender the feedstock and push the changes to your PR.
7575
Make sure to tick the ``Allow edits from maintainers.`` button locate at the bottom of the right side bar of
76-
the PR. If you say this phrase in an issue comment, the bot will create a new pull request with the requested
77-
re-rendering completed.
76+
the PR. If you enter this phrase in the comment for an issue, the bot will create a new pull request, with the requested
77+
re-rendering being completed.
7878

7979

8080
@conda-forge-admin, please add noarch: python
8181
---------------------------------------------
8282

83-
Entering the above phrase in a PR or issue of a feedstock will add ``noarch: python`` to the build and rerender the feedstock
83+
Entering the above phrase in a PR or an issue of a feedstock will add ``noarch: python`` to the build and rerender the feedstock
8484
for you.
8585

8686

8787
@conda-forge-admin, please update for conda-build 3
8888
---------------------------------------------------
8989

90-
This command will attempt to update a recipe to the new conda-build 3 format. It can be sent either in an issue or a PR.
90+
This command will attempt to update a recipe to the new ``conda-build 3`` format. It can be sent either in an issue or a PR.
9191

9292
Note that this update command is kind of a hack, and things might go wrong. Make sure to look over the changes, and ask for help if you're not sure about something.
9393

@@ -158,7 +158,7 @@ Here we describe common issues with the CI Services that conda-forge builds.
158158

159159
Azure Pipelines
160160
---------------
161-
Azure is used to build packages for OS X, Linux (x86_64, native), Linux (ARMv8, emulated) and Linux (IBM Power8+, emulated).
161+
Azure is used to build packages for OSX, Linux (x86_64, native), Linux (ARMv8, emulated) and Linux (IBM Power8+, emulated).
162162
The build queue on Azure is substantially larger than on all the other providers.
163163
Azure builds have a maximum duration of 6 hours.
164164

@@ -173,7 +173,7 @@ If that doesn't work, a close/open will kick off a new build. You can also use t
173173
Using Azure for *everything*
174174
............................
175175

176-
Azure is the default provider for Linux and OS X. To use Azure for everything, add the following to ``conda-forge.yml`` in the root
176+
Azure is the default provider for Linux and OSX. To use Azure for everything, add the following to ``conda-forge.yml`` in the root
177177
of the feedstock.
178178

179179
.. code-block:: yaml
@@ -183,21 +183,21 @@ of the feedstock.
183183
184184
.. note::
185185

186-
Presently Azure has some issues building libraries using cmake on Windows. Azure does not have a VS2008 installation so building
186+
Presently Azure has some issues building libraries using cmake on Windows. Azure does not have a VS2008 installation, so building
187187
certain very old packages that require VC9 will fail.
188188

189189

190-
Travis CI (OS X, IBM Power 8+)
190+
TravisCI (OSX, IBM Power 8+)
191191
------------------------------
192192

193-
Travis CI is used to build packages for IBM Power 8+. After merging a staged-recipes pull request, it might be necessary to
194-
force sync your repositories in Travis CI to see the reload and cancel buttons. To do this please visit `<https://travis-ci.com/profile>`_
193+
TravisCI is used to build packages for IBM Power 8+. After merging a staged-recipes pull request, it might be necessary to
194+
force sync your repositories in TravisCI to see the reload and cancel buttons. To do this please visit `<https://travis-ci.com/profile>`_
195195
and click "Sync accounts".
196196

197197
Enabling Travis
198198
...............
199199

200-
TravisCI should only be needed to build recipes on OS X if there is a strange failure on Azure.
200+
TravisCI should only be needed to build recipes on OSX, if there is a strange failure on Azure.
201201

202202
Enable a build by adding the following to ``conda-forge.yml`` in the root of the feedstock.
203203

@@ -206,46 +206,46 @@ Enable a build by adding the following to ``conda-forge.yml`` in the root of the
206206
provider:
207207
osx: travis
208208
209-
For IBM Power 8+ builds, add the name of your feedstock to the list here
210-
`<https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/migrations/arch_rebuild.txt>`_
209+
For IBM Power 8+ builds, add the name of your feedstock to the list `here
210+
<https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/migrations/arch_rebuild.txt>`_
211211
via a pull request.
212212

213213

214-
CircleCI (Linux, OS X)
214+
CircleCI (Linux, OSX)
215215
----------------------
216-
Circle CI is a container-based CI service that conda-forge uses to build
217-
Linux packages. It can optionally build OS X packages.
216+
CircleCI is a container-based CI service that conda-forge uses to build
217+
Linux packages. It can optionally build OSX packages.
218218

219219
Linux builds are identical to those on Azure as both are built inside Docker containers.
220220

221221

222-
Using Circle for both Linux and OS X
222+
Using Circle for both Linux and OSX
223223
....................................
224224

225-
To use CircleCI for OS X, add the following to ``conda-forge.yml`` in the root of the feedstock.
225+
To use CircleCI for OSX, add the following to ``conda-forge.yml`` in the root of the feedstock.
226226

227227
.. code-block:: yaml
228228
229229
provider:
230230
osx: circle
231231
linux: circle
232232
233-
CircleCI for OS X should be used for OS X only when Travis-CI resources (50 minutes of build time per job) are not enough as CircleCI gives more resources (2 hours of build time per job).
233+
CircleCI for OSX should be used for OSX, only when TravisCI resources (50 minutes of build time per job) are not enough as CircleCI gives more resources (2 hours of build time per job).
234234

235-
Note that you need to rerender the feedstock once this change has been made.
235+
Note that you need to rerender the feedstock, once this change has been made.
236236

237237

238238
Enabling Circle on your Fork
239239
............................
240240

241-
If for some reason Circle CI is not triggering build from forks,
241+
If for some reason CircleCI is not triggering build from forks,
242242
Circle can be manually added for each fork. Circle calls this "Adding a Project" and
243-
`the official Circle's documentation is available here <https://circleci.com/docs/getting-started/#add-and-follow-more-projects>`_.
243+
`the official CircleCI documentation is available here <https://circleci.com/docs/getting-started/#add-and-follow-more-projects>`_.
244244
This effectively amounts to going to the `Add Projects <https://circleci.com/add-projects>`_
245245
page, finding the fork that you wish to enable, and clicking the "Build Project" button.
246246
This is not normally needed.
247247

248-
If CircleCI lacks permissions to checkout the source code, it will produce an error like follows::
248+
If CircleCI lacks permissions to checkout the source code, it will produce an error as follows::
249249

250250
Cloning into '.'...
251251
Warning: Permanently added the RSA host key for IP address '192.30.253.113' to the list of known hosts.
@@ -259,21 +259,21 @@ When this happens for a feedstock, it can be fixed using the `webservice <https:
259259
Otherwise (e.g. in a PR to staged-recipes), here are some things you can try:
260260

261261
* Log in and out of Circle CI.
262-
* Revoke Circle CI's access and then enable it again.
262+
* Revoke CircleCI's access and then enable it again.
263263
* In the "Checkout SSH keys" section of your Circle CI project settings, press "add user key".
264264

265265

266266
Drone.io
267267
--------
268268

269-
We use Drone.io for Linux ARMv8 builds. To enable these builds on your feedstock, make a pull request to add your feedstock to the list
269+
We use `Drone.io <https://drone.io>`_ for Linux ARMv8 builds. To enable these builds on your feedstock, make a pull request to add your feedstock to the list
270270
here `<https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/migrations/arch_rebuild.txt>`_.
271271

272272

273273
GitHub Actions
274274
--------------
275275

276-
We use GitHub actions to rerender feedstocks and run our pull request automerge service. We do not currently support builds on
276+
We use GitHub actions to rerender feedstocks and also run our pull request automerge service. We do not currently support builds on
277277
GitHub Actions.
278278

279279

0 commit comments

Comments
 (0)