Skip to content

Commit

Permalink
Document the release option for sources (#3204)
Browse files Browse the repository at this point in the history
TODO: Document why we recommend the resolution `strategy`.
  • Loading branch information
jstvz authored May 26, 2022
1 parent 8b18682 commit 991833b
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -377,17 +377,19 @@ By default, CumulusCI uses the resolution strategy ``production``, which will fe
This feature requires that the referenced repository be readable (for example,
it's public, or CumulusCI's GitHub service is configured with the token of a user who has read access to it).


It's also possible to fetch a specific ``tag``...
It's also possible to fetch a specific ``tag`` or ``release``, where ``release`` is one of ``latest``, ``previous``, or ``latest_beta``. For example...

.. code-block:: yaml
sources:
eda:
github: https://github.com/SalesforceFoundation/EDA
release: latest
npsp:
github: https://github.com/SalesforceFoundation/NPSP
tag: rel/3.163
or a specific ``commit`` or ``branch``. We recommend that most projects, however, use a resolution strategy.
You can also select a specific ``commit`` or ``branch``. We recommend that most projects, however, use a resolution strategy.

When the repo is listed under ``sources``, it's possible to run a task from NPSP...

Expand Down

0 comments on commit 991833b

Please sign in to comment.