Skip to content

Commit 642f299

Browse files
committed
docs: ci: update docs such that custom build scripts are called by build.py
1 parent bed8693 commit 642f299

1 file changed

Lines changed: 4 additions & 20 deletions

File tree

docs/creating-new/test/ci.rst

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -125,22 +125,12 @@ Environment variables:
125125

126126
* **TOOLCHAIN** - build matrix's **toolchain** parameter
127127
* **PROJECT_DIR** - **example** parameter
128+
* **SCRIPT** - full path to file defined by **script** parameter, called by ``build.py`` before build
128129

129-
Default build script for all runners is ``.github/workflows/ci/build.py`` (bash script)
130+
Default build script for all runners is ``.github/workflows/ci/build.py`` (python script)
130131

131-
.. literalinclude:: ../../../.github/workflows/ci/build.sh
132-
:language: BASH
133-
134-
Default build script for Windows runner - ``.github/workflows/ci/build.cmd`` (batch file) is similar.
135-
136-
* installs `Polly <https://github.com/cpp-pm/polly>`__ and all necessary dependencies
137-
* defines default environment variables
138-
* runs ``jenkins.py`` script to :ref:`test building of a project <testing locally>`.
139-
140-
.. warning::
141-
If you don't need to alter Polly installation or predefined environment variables,
142-
don't copy and modify default script. Instead call the default script from your custom script,
143-
see example.
132+
.. literalinclude:: ../../../.github/workflows/ci/build.py
133+
:language: PYTHON
144134

145135
**Examples of override build scripts:**
146136

@@ -155,22 +145,16 @@ for Ubuntu runner ``cmake/projects/<PACKAGE_NAME>/ci/build-ubuntu.sh``:
155145
pip install virtualenv
156146
sudo apt-get install libgl1-mesa-dev
157147
158-
bash .github/workflows/ci/build.sh
159-
160148
for macOS ``cmake/projects/<PACKAGE_NAME>/ci/build-macos.sh``
161149

162150
.. code-block:: bash
163151
164152
export HUNTER_JOBS_NUMBER=1
165153
pip install virtualenv
166154
167-
bash .github/workflows/ci/build.sh
168-
169155
for Windows ``cmake/projects/<PACKAGE_NAME>/ci/build.cmd``:
170156

171157
.. code-block:: batch
172158
173159
set HUNTER_JOBS_NUMBER=1
174160
pip install virtualenv
175-
176-
.github/workflows/ci/build.cmd

0 commit comments

Comments
 (0)