Documentation: remote URL inclusion updates (#49669)
This commit is contained in:
parent
cf70d71ba8
commit
748c7e5420
@ -686,7 +686,8 @@ the environment.
|
|||||||
spack:
|
spack:
|
||||||
include:
|
include:
|
||||||
- environment/relative/path/to/config.yaml
|
- environment/relative/path/to/config.yaml
|
||||||
- https://github.com/path/to/raw/config/packages.yaml
|
- path: https://github.com/path/to/raw/config/compilers.yaml
|
||||||
|
sha256: 26e871804a92cd07bb3d611b31b4156ae93d35b6a6d6e0ef3a67871fcb1d258b
|
||||||
- /absolute/path/to/packages.yaml
|
- /absolute/path/to/packages.yaml
|
||||||
- path: /path/to/$os/$target/environment
|
- path: /path/to/$os/$target/environment
|
||||||
optional: true
|
optional: true
|
||||||
@ -700,11 +701,11 @@ with the ``optional`` clause and conditional with the ``when`` clause. (See
|
|||||||
|
|
||||||
Files are listed using paths to individual files or directories containing them.
|
Files are listed using paths to individual files or directories containing them.
|
||||||
Path entries may be absolute or relative to the environment or specified as
|
Path entries may be absolute or relative to the environment or specified as
|
||||||
URLs. URLs to individual files need link to the **raw** form of the file's
|
URLs. URLs to individual files must link to the **raw** form of the file's
|
||||||
contents (e.g., `GitHub
|
contents (e.g., `GitHub
|
||||||
<https://docs.github.com/en/repositories/working-with-files/using-files/viewing-and-understanding-files#viewing-or-copying-the-raw-file-content>`_
|
<https://docs.github.com/en/repositories/working-with-files/using-files/viewing-and-understanding-files#viewing-or-copying-the-raw-file-content>`_
|
||||||
or `GitLab
|
or `GitLab
|
||||||
<https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository>`_).
|
<https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository>`_) **and** include a valid sha256 for the file.
|
||||||
Only the ``file``, ``ftp``, ``http`` and ``https`` protocols (or schemes) are
|
Only the ``file``, ``ftp``, ``http`` and ``https`` protocols (or schemes) are
|
||||||
supported. Spack-specific, environment and user path variables can be used.
|
supported. Spack-specific, environment and user path variables can be used.
|
||||||
(See :ref:`config-file-variables` for more information.)
|
(See :ref:`config-file-variables` for more information.)
|
||||||
|
@ -43,6 +43,20 @@ or specified as URLs. Only the ``file``, ``ftp``, ``http`` and ``https`` protoco
|
|||||||
schemes) are supported. Spack-specific, environment and user path variables
|
schemes) are supported. Spack-specific, environment and user path variables
|
||||||
can be used. (See :ref:`config-file-variables` for more information.)
|
can be used. (See :ref:`config-file-variables` for more information.)
|
||||||
|
|
||||||
|
A ``sha256`` is required for remote file URLs and must be specified as follows:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
include:
|
||||||
|
- path: https://github.com/path/to/raw/config/compilers.yaml
|
||||||
|
sha256: 26e871804a92cd07bb3d611b31b4156ae93d35b6a6d6e0ef3a67871fcb1d258b
|
||||||
|
|
||||||
|
Additionally, remote file URLs must link to the **raw** form of the file's
|
||||||
|
contents (e.g., `GitHub
|
||||||
|
<https://docs.github.com/en/repositories/working-with-files/using-files/viewing-and-understanding-files#viewing-or-copying-the-raw-file-content>`_
|
||||||
|
or `GitLab
|
||||||
|
<https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository>`_).
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
Recursive includes are not currently processed in a breadth-first manner
|
Recursive includes are not currently processed in a breadth-first manner
|
||||||
|
Loading…
Reference in New Issue
Block a user