Skip to content

Commit

Permalink
Add note on specifying ref
Browse files Browse the repository at this point in the history
Signed-off-by: Conor MacBride <[email protected]>
  • Loading branch information
ConorMacBride committed Dec 13, 2021
1 parent 7140913 commit 816d575
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/common.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@ To load the template, add the following to the beginning of the ``azure-pipeline
type: github
endpoint: <service connection name>
name: OpenAstronomy/azure-pipelines-templates
ref: master
where ``<service connection name>`` is the name of the service connection you
set up above. This will make the templates in this repository available in the
``OpenAstronomy`` namespace in the rest of the file. Note the ref allows you to
pin the template version you want, you can use ``master`` if you want the latest
version.
``OpenAstronomy`` namespace in the rest of the file.

.. note::
Specifying the ``ref`` property for the ``OpenAstronomy`` repository is not
recommended because the default branch of the ``azure-pipelines-templates``
repository may change in the future.
`Azure Pipelines will use the current default branch when a ref is not specified.
<https://docs.microsoft.com/en-us/azure/devops/pipelines/repos/multi-repo-checkout?view=azure-devops#checking-out-a-specific-ref>`__

0 comments on commit 816d575

Please sign in to comment.