aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2023-07-03 22:31:15 +0200
committerEgor Tensin <Egor.Tensin@gmail.com>2023-07-03 22:32:44 +0200
commitbe0b69971a4d8447d86f77b3d09b3820e8c9cb67 (patch)
treeda1e2075e9145186f92e28fea6061802d0842fca /docs
parentproject.ci.cmake -> project.ci.build (diff)
downloadcmake-common-be0b69971a4d8447d86f77b3d09b3820e8c9cb67.tar.gz
cmake-common-be0b69971a4d8447d86f77b3d09b3820e8c9cb67.zip
remove project.ci
The weird magic going on in the ci-{boost,build} scripts is honestly too weird. With hindsight, it seems to me that it's much better to just build a project with the same command during a CI run as when developing locally. Plus, I haven't really used either Travis or AppVeyor in quite some time, so this code was mostly untested really.
Diffstat (limited to '')
-rw-r--r--docs/ci.md69
1 files changed, 0 insertions, 69 deletions
diff --git a/docs/ci.md b/docs/ci.md
deleted file mode 100644
index 6f31b6f..0000000
--- a/docs/ci.md
+++ /dev/null
@@ -1,69 +0,0 @@
-`ci-boost` and `ci-build` are thin wrappers around `boost-download`/`boost-build`
-and `project-build` accordingly. They work by reading environment variables
-and passing their values as command line parameters to the more generic scripts.
-This facilitates matrix-building the project without too much fuss.
-
-For example, the following Travis workflow:
-
-```
-language: cpp
-os: linux
-dist: focal
-
-env:
- global:
- BOOST_VERSION: 1.65.0
- jobs:
- - CONFIGURATION=Debug PLATFORM=x64
- - CONFIGURATION=Release PLATFORM=x64
-
-before_script: ci-boost -- --with-filesystem
-script: ci-build --install
-```
-
-is roughly equivalent to running
-
-```
-boost-download --cache "$TRAVIS_BUILD_DIR/../build" -- 1.65.0
-mv -- \
- "$TRAVIS_BUILD_DIR/../build/boost_1_65_0" \
- "$TRAVIS_BUILD_DIR/../build/boost"
-
-boost-build \
- --platform x64 \
- --configuration Debug Release \
- -- \
- "$TRAVIS_BUILD_DIR/../build/boost" \
- --with-filesystem
-
-for configuration in Debug Release; do
- project-build \
- --platform x64 \
- --configuration "$configuration" \
- --boost "$TRAVIS_BUILD_DIR/../build/boost" \
- --build "$TRAVIS_BUILD_DIR/../build/cmake" \
- --install "$TRAVIS_BUILD_DIR/../build/install" \
- -- \
- "$TRAVIS_BUILD_DIR" \
- TMP
-done
-```
-
-Caching
--------
-
-`ci-boost` downloads the Boost distribution archive to the "../build/"
-directory (resolved relatively to the root checkout directory). You can cache
-the archive like this (using GitHub Actions as an example):
-
-```
-- name: Cache Boost
- uses: actions/cache@v2
- with:
- path: '${{ runner.workspace }}/build/boost_*.tar.gz'
- key: 'boost_${{ env.BOOST_VERSION }}'
-
-- name: Build Boost
- # This won't re-download the archive unnecessarily.
- run: ci-boost -- --with-filesystem
-```