我有一个使用'strategy'='matrix'的工作流程以及要构建的特定配置的列表。
#
# build-N-test-v2.1-Dev and build-N-test-v2.1-Release are neary
# identical, but a few tests are commented out (to not needlessly stress CI system)
# for v2.1-Dev builds
#
# NOTE: I've tried many tricks - none which seem to work - to get this working on one file with one
# workflow and tests
# https://github.community/t/what-is-the-correct-if-condition-syntax-for-checking-matrix-os-version/16221
# https://github.community/t/how-to-conditionally-include-exclude-items-in-matrix-eg-based-on-branch/16853
#
# but none seem to work
#
name: build-N-test-v2.1-Dev
on:
push:
branches:
- v2.1-Dev
#- v2.1-Release
workflow_dispatch:
inputs:
ignored:
description: "ignored"
required: false
default: ""
## NB: JOBS section IDENTICAL between v2.1-Dev and 2.1-Release files EXCEPT that on v2.1-Dev file
## comment out all entries marked with includeInDevBranchBuilds: false
jobs:
build-n-test-Linux:
runs-on: ${{ matrix.runs_on }}
strategy:
#
# Configuration notes
# o --debug-symbols false to reduce build disk size (and we aren't debugging anyhow) in many debug configurations
#
matrix:
include:
# ## SADLY: Container operations are only supported on Linux runners
# - displayTargetName: windows-DBG
# os: windows
# compiler: g++-8
# runs_on: windows-latest
# container_image: sophistsolutionsinc/stroika-buildvm-windows-cygwin-vs2k19
# cpp_version: c++17
# config_name: Debug
# extra_config_args: --apply-default-debug-flags --trace2file enable
## centos 8
- displayTargetName: centos-8
os: unix
compiler: g++
runs_on: ubuntu-latest
container_image: sophistsolutionsinc/stroika-buildvm-centos-8-small
cpp_version: c++17
config_name: Release
extra_config_args: --apply-default-release-flags --trace2file enable
includeInDevBranchBuilds: true
## ubuntu 18.04
- displayTargetName: ubuntu-18.04-g++-8 (Debug)
os: unix
compiler: g++-8
runs_on: ubuntu-latest
container_image: sophistsolutionsinc/stroika-buildvm-ubuntu1804-regression-tests
cpp_version: c++17
config_name: Debug
extra_config_args: --apply-default-debug-flags --trace2file enable --debug-symbols false
includeInDevBranchBuilds: true
- displayTargetName: ubuntu-18.04-cross-compile-raspberrypi (Debug)
os: unix
compiler: g++-8
runs_on: ubuntu-latest
container_image: sophistsolutionsinc/stroika-buildvm-ubuntu1804-regression-tests
cpp_version: c++17
config_name: Debug
extra_config_args: --apply-default-release-flags --trace2file enable --compiler-driver arm-linux-gnueabihf-g++-8 --cross-compiling true
includeInDevBranchBuilds: true
# ubuntu 20.04
# - displayTargetName: ubuntu-20.04-g++-9 (Debug)
# os: unix
# compiler: g++-9
# runs_on: ubuntu-latest
# container_image: sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests
# cpp_version: c++17
# config_name: Debug
# extra_config_args: --apply-default-debug-flags --trace2file enable --debug-symbols false
# includeInDevBranchBuilds: false
# - displayTargetName: ubuntu-20.04-g++-10 (Debug)
# os: unix
# compiler: g++-10
# runs_on: ubuntu-latest
# container_image: sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests
# cpp_version: c++17
# config_name: Debug
# extra_config_args: --apply-default-debug-flags --trace2file enable --debug-symbols false
# includeInDevBranchBuilds: false
- displayTargetName: ubuntu-20.04-g++-10
os: unix
compiler: g++-10
runs_on: ubuntu-latest
container_image: sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests
cpp_version: c++17
config_name: Release
extra_config_args: --apply-default-release-flags --trace2file enable
includeInDevBranchBuilds: true
# - displayTargetName: ubuntu-20.04-g++-10-c++2a
# os: unix
# compiler: g++-10
# runs_on: ubuntu-latest
# container_image: sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests
# cpp_version: c++2a
# config_name: Release
# extra_config_args: --apply-default-release-flags --trace2file enable
# includeInDevBranchBuilds: false
# - displayTargetName: ubuntu-20.04-clang++-10
# os: unix
# compiler: clang++-10
# runs_on: ubuntu-latest
# container_image: sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests
# cpp_version: c++17
# config_name: Release
# extra_config_args: --apply-default-release-flags --trace2file enable
# includeInDevBranchBuilds: false
### ATTEMPT TO COMPRESS 2 workflow files into one, but so far not working
### SEE
### https://stackoverflow.com/questions/65384420/how-to-make-a-github-action-matrix-element-conditional/65385385#65385385
###
#if: github.ref == 'refs/heads/v2.1-Release' || matrix.includeInDevBranchBuilds
env:
# vm has 2 virtual CPUs, but 8GB ram, so jobs=5 (empirical), and QUICK_BUILD avoids some internal testing
MAKEFLAGS: "--jobs=3 QUICK_BUILD=1"
container: ${{ matrix.container_image }}
steps:
- uses: actions/checkout@v2
- name: Build System Info
if: ${{ matrix.os=='unix' }}
run: |
lsb_release -d 2>/dev/null || true
echo "CWD=" `pwd`
echo "nproc=" `nproc`
grep "model name" /proc/cpuinfo | head -1
grep processor /proc/cpuinfo | wc -l
grep MemTotal /proc/meminfo
df -h
- name: Build System Info (Windows)
if: ${{ matrix.os=='windows' }}
run: |
echo "CWD=" `pwd`
df -h
- name: Configure ${{ matrix.config_name }}
run: |
./configure ${{ matrix.config_name }} --compiler-driver ${{ matrix.compiler }} ${{ matrix.extra_config_args }} --cppstd-version ${{ matrix.cpp_version }}
cat ConfigurationFiles/${{ matrix.config_name }}.xml
# Break out third-party-components to do clean so we dont run out of disk space, and break out TPC AND library
# to show the summary time for each part
- name: Make third-party-components
run: |
make third-party-components
make clean
- name: Make libraries
run: make libraries
- name: Make all
run: make all
- name: Run Tests
run: make run-tests
- name: Archive Samples Results
uses: actions/upload-artifact@v2
with:
name: Sample apps (${{ matrix.displayTargetName }})
path: |
Builds/${{ matrix.config_name }}/Samples-*
- name: Archive Log Results
uses: actions/upload-artifact@v2
with:
name: Log Data (${{ matrix.displayTargetName }})
path: |
Builds/${{ matrix.config_name }}/PerformanceDump.txt
/tmp/Trace*.txt
build-n-test-MacOS:
runs-on: ${{ matrix.runs_on }}
strategy:
matrix:
# Add to extra_config_args for build speed: --Xerces no --OpenSSL no --lzma no --boost no
include:
- displayTargetName: MacOS-Debug
os: macos-10.15
runs_on: macos-10.15
config_name: Debug
extra_config_args: --apply-default-debug-flags --trace2file enable
includeInDevBranchBuilds: true
# - displayTargetName: MacOS
# os: macos-10.15
# runs_on: macos-10.15
# config_name: Release
# extra_config_args: --apply-default-release-flags --trace2file enable
# includeInDevBranchBuilds: false
env:
# vm has 2 virtual CPUs, but 8GB ram, so jobs=5 (empirical), and QUICK_BUILD avoids some internal testing
MAKEFLAGS: "--jobs=3 QUICK_BUILD=1"
steps:
- uses: actions/checkout@v2
- name: Build System Info
run: |
echo "CWD: `pwd`"
df -h
system_profiler SPSoftwareDataType
sw_vers
# If we had docker ability, most of these would be built into a docker file
- name: Install Basic Build requirements
run: |
brew install gnu-sed
brew install p7zip
brew install automake
make install-realpath
- name: Configure
run: |
./configure ${{ matrix.config_name }} ${{ matrix.extra_config_args }}
cat ConfigurationFiles/${{ matrix.config_name }}.xml
- name: Build third-party-components
run: |
make third-party-components
make clean
- name: Build Library
run: |
make libraries
- name: Build All
run: |
make all
- name: Run-Tests
run: |
make run-tests
- name: Workaround GitHub-Actions-MacOS Issue with env.TMPDIR
run: |
mkdir /tmp/LOGS-ARCHIVE
cp $TMPDIR/Trace*.txt /tmp/LOGS-ARCHIVE
- name: DEBUG Workaround GitHub-Actions-MacOS Issue with env.TMPDIR
run: |
echo "TMPDIR=$TMPDIR"
echo "TMPDIR using ENV.TMPDIR=${{ env.TMPDIR }}"
# Just the echo line above shows empty, and then the ls line causes exit 1/failure
#ls -l ${{ env.TMPDIR }}/Trace*.txt
#if this gets fixed, then lose Workaround GitHub-Actions-MacOS, and directly reference ${{ env.TMPDIR }}/Trace*.txt in Archive Log Results
- name: Build System Info
run: |
df -h
- name: Archive Log Results
uses: actions/upload-artifact@v2
with:
name: Log Results (${{ matrix.displayTargetName }})
path: |
Builds/${{ matrix.config_name }}/PerformanceDump.txt
/tmp/LOGS-ARCHIVE
#${{ env.TMPDIR }}/Trace*.txt
- name: Archive Sample Results
uses: actions/upload-artifact@v2
with:
name: Samples (${{ matrix.displayTargetName }})
path: |
Builds/${{ matrix.config_name }}/Samples-*
build-n-test-Windows:
runs-on: ${{ matrix.runs_on }}
strategy:
matrix:
# Add to extra_config_args for build speed: --Xerces no --OpenSSL no --lzma no --boost no
include:
- displayTargetName: windows-x86-Debug
os: windows
runs_on: windows-latest
container_image: sophistsolutionsinc/stroika-buildvm-windows-cygwin-vs2k19
config_name: Debug
extra_config_args: --arch x86 --apply-default-debug-flags --trace2file enable
includeInDevBranchBuilds: true
# - displayTargetName: windows-x86-Release
# os: windows
# runs_on: windows-latest
# container_image: sophistsolutionsinc/stroika-buildvm-windows-cygwin-vs2k19
# config_name: Release
# extra_config_args: --arch x86 --apply-default-release-flags --trace2file enable
# includeInDevBranchBuilds: false
# - displayTargetName: windows-x86_64-Debug
# os: windows
# runs_on: windows-latest
# container_image: sophistsolutionsinc/stroika-buildvm-windows-cygwin-vs2k19
# config_name: Debug
# extra_config_args: --arch x86_64 --apply-default-debug-flags --trace2file enable
# includeInDevBranchBuilds: false
# - displayTargetName: windows-x86_64-Release
# os: windows
# runs_on: windows-latest
# container_image: sophistsolutionsinc/stroika-buildvm-windows-cygwin-vs2k19
# config_name: Release
# extra_config_args: --arch x86 --apply-default-release-flags --trace2file enable
# includeInDevBranchBuilds: false
env:
# vm has 2 virtual CPUs, but 8GB ram, so jobs=5 (empirical), and QUICK_BUILD avoids some internal testing
MAKEFLAGS: "--jobs=3 QUICK_BUILD=1"
ARTIFACTS_DIR: "c:/Artifacts/"
steps:
- uses: actions/checkout@v2
# https://stackoverflow.com/questions/58033366/how-to-get-current-branch-within-github-actions
- name: Extract branch name
shell: bash
run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
id: extract_branch
- name: Build System Info
shell: "bash"
run: |
echo "CWD: `pwd`"
df -h
systeminfo
echo NUMBER_OF_PROCESSORS=$NUMBER_OF_PROCESSORS
- name: docker pull ${{ matrix.container_image }}
run: docker pull ${{ matrix.container_image }}
- name: Start docker build environment
run: |
docker run --tty --memory 5G --cpus 2 --storage-opt 'size=50GB' --detach --name buildContainer ${{ matrix.container_image }}
- name: Print Info about docker system
shell: "bash"
run: |
docker ps -a
docker exec buildContainer systeminfo
docker exec buildContainer df -h
- name: Git Checkout
shell: "bash"
run: |
docker exec buildContainer sh -c "git clone https://github.com/SophistSolutions/Stroika.git && cd Stroika && git checkout ${{ steps.extract_branch.outputs.branch }}"
- name: Configure
shell: "bash"
run: |
docker exec --workdir c:/Stroika buildContainer sh -c "./configure ${{ matrix.config_name }} ${{ matrix.extra_config_args }}"
docker exec --workdir c:/Stroika buildContainer cat ConfigurationFiles/${{ matrix.config_name }}.xml
- name: Build
shell: "bash"
run: |
docker exec --workdir c:/Stroika --env MAKEFLAGS="$MAKEFLAGS" buildContainer make all
- name: Run-Tests
shell: "bash"
run: |
docker exec --workdir c:/Stroika --env MAKEFLAGS="$MAKEFLAGS" buildContainer make run-tests
- name: Build System Info
shell: "bash"
run: |
df -h
docker exec buildContainer df -h
- name: Copy Build Artifacts
shell: "bash"
# due to flaws in docker (windows must stop) - and cp no wildcards
run: |
docker exec --workdir c:/Stroika buildContainer bash -c 'mkdir TRACE_LOGS && cp $TEMP/Trace*.txt TRACE_LOGS/'
docker stop buildContainer
docker cp buildContainer:Stroika/Builds/${{ matrix.config_name }}/ $ARTIFACTS_DIR 2> /dev/null
docker cp buildContainer:Stroika/TRACE_LOGS $ARTIFACTS_DIR 2> /dev/null
rm -rf $ARTIFACTS_DIR/{ThirdPartyComponents,Tests,*.lib}
- name: Archive Log Results
uses: actions/upload-artifact@v2
with:
name: Log Results (${{ matrix.displayTargetName }})
path: |
${{ env.ARTIFACTS_DIR }}PerformanceDump.txt
${{ env.ARTIFACTS_DIR }}TRACE_LOGS
- name: Archive Sample Results
uses: actions/upload-artifact@v2
with:
name: Samples (${{ matrix.displayTargetName }})
path: |
${{ env.ARTIFACTS_DIR }}Samples-*
但是我只想在branch = v2.1-Release时才构建一些配置。那就是-在大多数情况下-仅构建一个或两个配置,但在发布时构建更多。
我已经通过克隆脚本(工作流程)并重命名了一些内容并注释掉了这些内容来完成了此任务。但是,如果该机制可以处理矩阵元素,那就太好了。
我意识到有一个“如果”功能可以添加到每个步骤,但是这将创建大量具有禁用步骤的作业。我想要的是,对于具有if部分评估为false的每个矩阵元素,根本不增加这些工作。
TLDR:通过过滤要在先前的构建作业/步骤中使用的配置,并将该过滤的结果用作作业中的矩阵值,您可以使用一个工作流程来完成所需的build-n-test
工作。
较长版本:
您可以通过将的值设置为上一个作业的反序列化(即matrix_prep),根据某些标准创建一个job
(即build-n-test),其中的值strategy.matrix
不同。先前的工作将负责根据您的自定义条件构造值。以下yaml对此进行了演示(稍后将包含一个副本,并在其中添加注释以进行解释):strategy.matrix
output
matrix
name: Configurable Build Matrix
on: push
jobs:
matrix_prep:
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.set-matrix.outputs.matrix }}
steps:
- name: Check out code into the Go module directory
uses: actions/checkout@v2
- id: set-matrix
run: |
branchName=$(echo '${{ github.ref }}' | sed 's,refs/heads/,,g')
matrix=$(jq --arg branchName "$branchName" 'map(. | select((.runOn==$branchName) or (.runOn=="always")) )' matrix_includes.json)
echo ::set-output name=matrix::{\"include\":$(echo $matrix)}\"
build-n-test:
needs: matrix_prep
runs-on: ${{ matrix.runs_on }}
strategy:
matrix: ${{fromJson(needs.matrix_prep.outputs.matrix)}}
steps:
- run: echo "Hello ${{ matrix.someValue }}"
matrix_includes.json
在本段之后可以找到在设置矩阵任务中使用的文件的内容。要查看问题的矩阵配置像JSON一样,请查看此答案底部的内容。我之所以选择将JSON文件与工作流定义本身分开,是因为我发现在工作流本身中包含原始JSON非常混乱(特别是如果JSON文件很大的话)。
[
{
"runs_on":"ubuntu-16.04",
"someValue":"Foo",
"runOn":"always"
},
{
"runs_on":"ubuntu-18.04",
"someValue":"Bar",
"runOn":"v2.1-Release"
},
{
"runs_on":"ubuntu-20.04",
"someValue":"Hello again",
"runOn":"v2.1-Release"
}
]
使用上述设置,所有构建都将包含一种配置,并且仅当分支名称与v2.1-Release匹配时,才包含两种配置。通过对Workflow文件中的sed
和jq
选项进行一些调整,可以放宽分支名称限制,以便您可以为包括在内的所有分支-Release
(而不只是单个分支)运行配置。如果有兴趣,我可以在此答案中包括此内容(因为它不一定与您当前的问题相符)。
set-matrix
工作说明就set-matrix
任务而言,请参考以下注释:
# ${{ github.ref }} returns the full git ref. As such, 'refs/heads/` should be stripped for easier future use
branchName=$(echo '${{ github.ref }}' | sed 's,refs/heads/,,g')
# Use jq to read in a json file that represents the matrix configuration. Each block has a 'runOn' property.
# The jq filter is setup to only output items that are set to 'always' or that have a branch name that matches
# the current branch.
matrix=$(jq --arg branchName "$branchName" 'map(. | select((.runOn==$branchName) or (.runOn=="always")) )' matrix_includes.json)
# This 'echo' uses a special syntax so that the output of this job is set correctly
echo ::set-output name=matrix::{\"include\":$(echo $matrix)}\"
以下yaml内容应与上面的内容相同,并带有一些其他注释以帮助解释。
name: Configurable Build Matrix
on: push
jobs:
matrix_prep:
# Using a separate job and agent so as to be able to use tools like 'sed' and 'jq'
runs-on: ubuntu-latest
# Defining outputs of a job allows for easier consumption and use
outputs:
matrix: ${{ steps.set-matrix.outputs.matrix }}
steps:
# Checking out code as the set-matrix step utilizes a file named matrix_includes.json
- name: Check out code into the Go module directory
uses: actions/checkout@v2
# This step is explained more in a following section
- id: set-matrix
run: |
branchName=$(echo '${{ github.ref }}' | sed 's,refs/heads/,,g')
matrix=$(jq --arg branchName "$branchName" 'map(. | select((.runOn==$branchName) or (.runOn=="always")) )' matrix_includes.json)
echo ::set-output name=matrix::{\"include\":$(echo $matrix)}\"
build-n-test:
# By stating 'needs' here, the output of 'matrix_prep' is available to this job
needs: matrix_prep
runs-on: ${{ matrix.runs_on }}
strategy:
# We need to convert the json string output into an object that the GitHub Workflow expects.
# Thankfully, the json-schema for Workflows allows 'matrix' to be set to an expression.
matrix: ${{fromJson(needs.matrix_prep.outputs.matrix)}}
steps:
# Output a configuration specific value as proof and as a sanity check
- run: echo "Hello ${{ matrix.someValue }}"
我将两个文件放在一起进行演示:
以下两个屏幕截图来自使用相同工作流程定义的不同分支上的运行。请注意,两者之间的build-n-test作业数量不同:
这是由于第一次构建发生在main
分支上,而第二次发生在v2.1-Release
分支上。从matrix_includes.json
上面的包含文件可以看出,这是可以预期的,因为两个配置被设置为仅在分支为时才运行v2.1-Release
,而只有一个配置被设置为始终运行。
通过使用jq从json数组中选择runOn
值设置为always
或与current匹配的对象来完成过滤branchName
。这是对我前面提到的逻辑的轻微调整:includeInDevBranchBuilds
我没有使用runOn
,而是使用了它,因为它似乎在此特定示例中效果更好。
该set-matrix
步骤使用上一行中设置的值:branchName=$(echo '${{ github.ref }}' | sed 's,refs/heads/.*-,,g')
。该行将从refs/heads/
分支ref中删除,并将结果存储在value中branchName
。例如,如果您的分支是2.1-Release
,branchName
将被设置为2.1-Release
,则来自前面的过滤器将匹配具有"runOn":"2.1-Release"
或的 任何对象"runOn":"always"
。
创建JSON文件是为了模拟您链接的工作流程中的语句内容includes
。JSON被用作GitHub Actions内置的JSON函数。作为示例,以下是我对将您的matrix:include
部分转换为JSON的看法。请注意,我已更改includeInDevBranchBuilds
为runOn
,将值设置为always
或v2.1-Release
。
[
{
"displayTargetName": "centos-8",
"os": "unix",
"compiler": "g++",
"runs_on": "ubuntu-latest",
"container_image": "sophistsolutionsinc/stroika-buildvm-centos-8-small",
"cpp_version": "c++17",
"config_name": "Release",
"extra_config_args": "--apply-default-release-flags --trace2file enable",
"runOn": "always"
},
{
"displayTargetName": "ubuntu-18.04-g++-8 (Debug)",
"os": "unix",
"compiler": "g++-8",
"runs_on": "ubuntu-latest",
"container_image": "sophistsolutionsinc/stroika-buildvm-ubuntu1804-regression-tests",
"cpp_version": "c++17",
"config_name": "Debug",
"extra_config_args": "--apply-default-debug-flags --trace2file enable",
"runOn": "always"
},
{
"displayTargetName": "ubuntu-20.04-g++-9 (Debug)",
"os": "unix",
"compiler": "g++-9",
"runs_on": "ubuntu-latest",
"container_image": "sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests",
"cpp_version": "c++17",
"config_name": "Debug",
"extra_config_args": "--apply-default-debug-flags --trace2file enable",
"runOn": "v2.1-Release"
},
{
"displayTargetName": "ubuntu-20.04-g++-10 (Debug)",
"os": "unix",
"compiler": "g++-10",
"runs_on": "ubuntu-latest",
"container_image": "sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests",
"cpp_version": "c++17",
"config_name": "Debug",
"extra_config_args": "--apply-default-debug-flags --trace2file enable",
"runOn": "v2.1-Release"
},
{
"displayTargetName": "ubuntu-20.04-g++-10",
"os": "unix",
"compiler": "g++-10",
"runs_on": "ubuntu-latest",
"container_image": "sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests",
"cpp_version": "c++17",
"config_name": "Release",
"extra_config_args": "--apply-default-release-flags --trace2file enable",
"runOn": "always"
},
{
"displayTargetName": "ubuntu-20.04-g++-10-c++2a",
"os": "unix",
"compiler": "g++-10",
"runs_on": "ubuntu-latest",
"container_image": "sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests",
"cpp_version": "c++2a",
"config_name": "Release",
"extra_config_args": "--apply-default-release-flags --trace2file enable",
"runOn": "v2.1-Release"
},
{
"displayTargetName": "ubuntu-20.04-clang++-10",
"os": "unix",
"compiler": "clang++-10",
"runs_on": "ubuntu-latest",
"container_image": "sophistsolutionsinc/stroika-buildvm-ubuntu2004-regression-tests",
"cpp_version": "c++17",
"config_name": "Release",
"extra_config_args": "--apply-default-release-flags --trace2file enable",
"runOn": "v2.1-Release"
}
]
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句