Skip to content

Commit e973151

Browse files
PawelWMSPawelWMS
authored
Added simple package build PR checks. (#13900)
1 parent 4104f73 commit e973151

2 files changed

Lines changed: 182 additions & 0 deletions

File tree

‎.github/actions/checkout-with-stable-pkgs/action.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Copyright (c) Microsoft Corporation.
2+
# Licensed under the MIT License.
3+
4+
name: "Stable specs and manifests checkout"
5+
description: "Checks out the repo, and a stable version of both specs and manifests."
6+
runs:
7+
using: "composite"
8+
steps:
9+
- name: Checkout repository
10+
uses: actions/checkout@v4
11+
with:
12+
fetch-depth: 0
13+
fetch-tags: true
14+
15+
- name: Checkout stable specs and manifests
16+
shell: bash
17+
run: git checkout 3.0-stable -- SPECS/ toolkit/resources/manifests/package/*.txt

‎.github/workflows/check-package-builds.yml‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
# Copyright (c) Microsoft Corporation.
2+
# Licensed under the MIT License.
3+
4+
# This check verifies basic package build success and failure cases.
5+
# It should only be dependent on toolkit changes, not on the specs.
6+
# This is why each build uses the 3.0-stable version of the specs and manifests.
7+
8+
name: Package build checks
9+
10+
env:
11+
REGULAR_PKG: words
12+
REGULAR_PKG_SPEC_PATH: SPECS/words/words.spec
13+
TOOLCHAIN_PKG: xz
14+
15+
on:
16+
push:
17+
branches: [3.0*, fasttrack/3.0]
18+
paths:
19+
- ".github/workflows/check-package-builds.yml"
20+
- "toolkit/Makefile"
21+
- "toolkit/scripts/*"
22+
- "toolkit/tools/*"
23+
pull_request:
24+
branches: [3.0*, fasttrack/3.0]
25+
paths:
26+
- ".github/workflows/check-package-builds.yml"
27+
- "toolkit/Makefile"
28+
- "toolkit/scripts/*"
29+
- "toolkit/tools/*"
30+
31+
jobs:
32+
package-checks:
33+
name: ${{ matrix.check-name }}
34+
runs-on: ubuntu-latest
35+
strategy:
36+
fail-fast: false
37+
matrix:
38+
include:
39+
- check-name: "Simple package build succeeds"
40+
package-type: "REGULAR_PKG"
41+
extra-args: ""
42+
43+
- check-name: "Simple package build fails"
44+
package-type: "REGULAR_PKG"
45+
error-pattern: "Number of failed SRPMs:\\s+1\\s*$"
46+
extra-args: ""
47+
build-prep: |
48+
# Adding an invalid command to the '%prep' section will cause the build to fail.
49+
sed -i '/%prep/a this-command-should-fail-because-its-not-a-command-at-all' "$REGULAR_PKG_SPEC_PATH"
50+
51+
- check-name: "Toolchain package rebuild succeeds"
52+
package-type: "TOOLCHAIN_PKG"
53+
extra-args: "ALLOW_TOOLCHAIN_REBUILDS=y"
54+
55+
- check-name: "Toolchain package rebuild fails"
56+
package-type: "TOOLCHAIN_PKG"
57+
error-pattern: "Number of toolchain SRPM conflicts:\\s+1\\s*$"
58+
extra-args: "ALLOW_TOOLCHAIN_REBUILDS=n"
59+
build-prep: ""
60+
61+
- check-name: "None license check does not break the build"
62+
package-type: "REGULAR_PKG"
63+
extra-args: "LICENSE_CHECK_MODE=none"
64+
build-prep: |
65+
license_file_name=$(grep -oP '^%license\s+\K\S+' "$REGULAR_PKG_SPEC_PATH")
66+
if [[ -z "$license_file_name" ]]; then
67+
echo "ERROR: no license file found in the spec $REGULAR_PKG_SPEC_PATH"
68+
exit 1
69+
fi
70+
# Tagging a license file as a documentation file will not fail the license check on the 'none' level.
71+
sed -i "/^%license/a %doc $license_file_name" "$REGULAR_PKG_SPEC_PATH"
72+
73+
- check-name: "Warning-only license check does not break the build"
74+
package-type: "REGULAR_PKG"
75+
extra-args: "LICENSE_CHECK_MODE=warn"
76+
build-prep: |
77+
license_file_name=$(grep -oP '^%license\s+\K\S+' "$REGULAR_PKG_SPEC_PATH")
78+
if [[ -z "$license_file_name" ]]; then
79+
echo "ERROR: no license file found in the spec $REGULAR_PKG_SPEC_PATH"
80+
exit 1
81+
fi
82+
# Tagging a license file as a documentation file will not fail the license check on the 'warn' level.
83+
sed -i "/^%license/a %doc $license_file_name" "$REGULAR_PKG_SPEC_PATH"
84+
85+
- check-name: "Fatal license check succeeds on duplicated license as documentation"
86+
package-type: "REGULAR_PKG"
87+
extra-args: "LICENSE_CHECK_MODE=fatal"
88+
build-prep: |
89+
license_file_name=$(grep -oP '^%license\s+\K\S+' "$REGULAR_PKG_SPEC_PATH")
90+
if [[ -z "$license_file_name" ]]; then
91+
echo "ERROR: no license file found in the spec $REGULAR_PKG_SPEC_PATH"
92+
exit 1
93+
fi
94+
# Tagging a license file as a documentation file will not fail the license check on the 'fatal' level.
95+
sed -i "/^%license/a %doc $license_file_name" "$REGULAR_PKG_SPEC_PATH"
96+
97+
- check-name: "Fatal license check fails"
98+
package-type: "REGULAR_PKG"
99+
error-pattern: "Number of SRPMs with license errors:\\s+1\\s*$"
100+
extra-args: "LICENSE_CHECK_MODE=fatal"
101+
build-prep: |
102+
if ! grep -q '^%license' "$REGULAR_PKG_SPEC_PATH"; then
103+
echo "ERROR: no '%license' macro found in the spec $REGULAR_PKG_SPEC_PATH"
104+
exit 1
105+
fi
106+
# Tagging a license file as a documentation file will cause the license check to fail.
107+
sed -i "s/^%license/%doc/" "$REGULAR_PKG_SPEC_PATH"
108+
109+
- check-name: "Pedantic license check fails"
110+
package-type: "REGULAR_PKG"
111+
error-pattern: "Number of SRPMs with license errors:\\s+1\\s*$"
112+
extra-args: "LICENSE_CHECK_MODE=pedantic"
113+
build-prep: |
114+
license_file_name=$(grep -oP '^%license\s+\K\S+' "$REGULAR_PKG_SPEC_PATH")
115+
if [[ -z "$license_file_name" ]]; then
116+
echo "ERROR: no license file found in the spec $REGULAR_PKG_SPEC_PATH"
117+
exit 1
118+
fi
119+
sed -i "/^%license/a %doc $license_file_name" "$REGULAR_PKG_SPEC_PATH"
120+
121+
steps:
122+
- uses: actions/checkout@v4
123+
124+
- name: Checkout a stable version of the specs
125+
uses: ./.github/actions/checkout-with-stable-pkgs
126+
127+
- name: Prepare the build environment
128+
if: ${{ matrix.build-prep != '' }}
129+
run: |
130+
set -euo pipefail
131+
132+
${{ matrix.build-prep }}
133+
134+
- name: Run the build
135+
run: |
136+
set -euo pipefail
137+
138+
if sudo make -C toolkit -j$(nproc) build-packages \
139+
PACKAGE_REBUILD_LIST="${{ env[matrix.package-type] }}" \
140+
REBUILD_TOOLS=y \
141+
SRPM_PACK_LIST="${{ env[matrix.package-type] }}" \
142+
${{ matrix.extra-args }} 2>&1 | tee build.log; then
143+
touch build.succeeded
144+
fi
145+
146+
- name: Check the results
147+
run: |
148+
set -euo pipefail
149+
150+
if [[ -z "${{ matrix.error-pattern }}" ]]; then
151+
if [[ ! -f build.succeeded ]]; then
152+
echo "Build failed, but it was expected to succeed."
153+
exit 1
154+
fi
155+
else
156+
if [[ -f build.succeeded ]]; then
157+
echo "Build succeeded, but it was expected to fail."
158+
exit 1
159+
fi
160+
161+
if ! grep -qP '${{ matrix.error-pattern }}' build.log; then
162+
echo "Build failed, but not with the expected error message."
163+
exit 1
164+
fi
165+
fi

0 commit comments

Comments
 (0)