Skip to content

Commit af52e7e

Browse files
authored
Update CI to actions/checkout@v5 per Actions complaint, and REUSE to REUSE.toml (#2713)
* Update CI to actions/checkout@v5 per Actions complaint. Update REUSE to REUSE.toml exception file instead of .reuse/dep5. * Update upload/download-artifact actions
1 parent ab80b9e commit af52e7e

4 files changed

Lines changed: 86 additions & 64 deletions

File tree

.github/workflows/CI.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
container: khronosgroup/docker-images@sha256:f1ca671f3bdb10ad49e238b9bf28853088a21af49504498fc9084c9b4fea4762
3232

3333
steps:
34-
- uses: actions/checkout@v4
34+
- uses: actions/checkout@v5
3535
- name: REUSE license checker
3636
run: reuse lint
3737

@@ -46,7 +46,7 @@ jobs:
4646
# This causes 'fatal: detected dubious ownership in repostory' and
4747
# failure to run the checks, although it is not actually propagated
4848
# back to the Makefile as errors.
49-
- uses: actions/checkout@v4
49+
- uses: actions/checkout@v5
5050
- name: Internal self-test of the check_spec_links script
5151
run: pytest test*.py
5252
working-directory: scripts
@@ -70,7 +70,7 @@ jobs:
7070
# This only runs on merge requests where CI_COMMIT_BRANCH is defined, and is
7171
# a valid extension name, or is mapped to one in an exception list in
7272
# scripts/testSpecVersion.py
73-
- uses: actions/checkout@v4
73+
- uses: actions/checkout@v5
7474
- run: |
7575
echo "Branch name is ${{github.ref_name}}"
7676
python3 scripts/testSpecVersion.py -branch ${{github.ref_name}} -test -build
@@ -81,7 +81,7 @@ jobs:
8181
container: khronosgroup/docker-images@sha256:f1ca671f3bdb10ad49e238b9bf28853088a21af49504498fc9084c9b4fea4762
8282

8383
steps:
84-
- uses: actions/checkout@v4
84+
- uses: actions/checkout@v5
8585
- run: ./testBuild
8686

8787
spec-core:
@@ -90,7 +90,7 @@ jobs:
9090
container: khronosgroup/docker-images@sha256:f1ca671f3bdb10ad49e238b9bf28853088a21af49504498fc9084c9b4fea4762
9191

9292
steps:
93-
- uses: actions/checkout@v4
93+
- uses: actions/checkout@v5
9494
- run: ./makeSpec -clean -spec core -genpath gencore QUIET= -j${nproc} -Otarget html
9595

9696
spec-generate:
@@ -99,7 +99,7 @@ jobs:
9999
container: khronosgroup/docker-images@sha256:f1ca671f3bdb10ad49e238b9bf28853088a21af49504498fc9084c9b4fea4762
100100

101101
steps:
102-
- uses: actions/checkout@v4
102+
- uses: actions/checkout@v5
103103
- name: Validate the XML before building anything using it
104104
run: make -C xml validate
105105
- name: Build the ratified-only spec, to catch incorrect ifdef errors affecting ratification submissions
@@ -117,7 +117,7 @@ jobs:
117117
# Make a single tarball to upload instead
118118
run: tar -cvf spec-outputs.tar gen/ genrat/
119119
- name: Archive generated spec
120-
uses: actions/upload-artifact@v4
120+
uses: actions/upload-artifact@v7
121121
with:
122122
name: spec-outputs
123123
path: spec-outputs.tar
@@ -130,11 +130,11 @@ jobs:
130130
continue-on-error: true
131131

132132
steps:
133-
- uses: actions/checkout@v4
133+
- uses: actions/checkout@v5
134134
# Generate the vulkan C++ header (vulkan.hpp)
135135
# Failure (should be) allowed, for now
136136
- name: Download generated spec
137-
uses: actions/download-artifact@v4
137+
uses: actions/download-artifact@v8
138138
with:
139139
name: spec-outputs
140140
- name: Unpack generated spec
@@ -152,7 +152,7 @@ jobs:
152152
cmake --build build --parallel
153153
cp vulkan/*.hpp ${SPEC_DIR}/gen/include/vulkan/
154154
- name: Upload generated hpp
155-
uses: actions/upload-artifact@v4
155+
uses: actions/upload-artifact@v7
156156
with:
157157
name: hpp-outputs
158158
path: gen/include/
@@ -166,7 +166,7 @@ jobs:
166166
continue-on-error: true
167167

168168
steps:
169-
- uses: actions/checkout@v4
169+
- uses: actions/checkout@v5
170170
- name: Sparse/shallow clone of CTS GitHub repository to pull only relevant parts
171171
run: |
172172
git clone --sparse --depth 1 --single-branch --branch main https://github.com/KhronosGroup/VK-GL-CTS.git
@@ -190,9 +190,9 @@ jobs:
190190
needs: spec-generate
191191

192192
steps:
193-
- uses: actions/checkout@v4
193+
- uses: actions/checkout@v5
194194
- name: Download generated files
195-
uses: actions/download-artifact@v4
195+
uses: actions/download-artifact@v8
196196
with:
197197
name: spec-outputs
198198
- name: Unpack generated spec
@@ -215,15 +215,15 @@ jobs:
215215
cpp_standard: [c++11, c++14, c++17, c++20, c++23]
216216

217217
steps:
218-
- uses: actions/checkout@v4
218+
- uses: actions/checkout@v5
219219
- name: Download generated spec
220-
uses: actions/download-artifact@v4
220+
uses: actions/download-artifact@v8
221221
with:
222222
name: spec-outputs
223223
- name: Unpack generated spec
224224
run: tar -xvf spec-outputs.tar
225225
- name: Download generated hpp
226-
uses: actions/download-artifact@v4
226+
uses: actions/download-artifact@v8
227227
with:
228228
name: hpp-outputs
229229
path: gen/include/

.reuse/dep5

Lines changed: 0 additions & 48 deletions
This file was deleted.

README.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ CONTRIBUTING.adoc Requirements for external contributions to the repository
2424
COPYING.adoc Copyright and licensing information
2525
CODE_OF_CONDUCT.adoc Code of Conduct
2626
LICENSE.adoc Summary of licenses used by files in the repository
27+
REUSE.toml License exceptions for the REUSE tool
2728
ChangeLog.adoc Change log summary for each public Vulkan spec update
2829
ChangeLogSC.adoc Change log summary for each public Vulkan SC spec update
2930
Makefile, make* Makefile and helper build scripts (see BUILD.adoc)

REUSE.toml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
version = 1
2+
SPDX-PackageName = "Vulkan-Docs"
3+
SPDX-PackageDownloadLocation = "https://github.com/KhronosGroup/Vulkan-Docs"
4+
5+
[[annotations]]
6+
path = ["images/**.svg", "config/chunkindex/custom.patch", "config/CI/**", "config/**/docinfo-header.html", "build_tests/expectations/**", "build_tests/images/**.svg", "images/proposals/**.svg"]
7+
precedence = "aggregate"
8+
SPDX-FileCopyrightText = "2015-2026 The Khronos Group Inc."
9+
SPDX-License-Identifier = "CC-BY-4.0"
10+
11+
[[annotations]]
12+
path = "katex/**"
13+
precedence = "aggregate"
14+
SPDX-FileCopyrightText = "2013-2019 Khan Academy and other contributors"
15+
SPDX-License-Identifier = "MIT"
16+
17+
[[annotations]]
18+
path = "config/chunkindex/lunr.js"
19+
precedence = "aggregate"
20+
SPDX-FileCopyrightText = "2019 Oliver Nightingale"
21+
SPDX-License-Identifier = "MIT"
22+
23+
[[annotations]]
24+
path = "config/optimize-pdf"
25+
precedence = "aggregate"
26+
SPDX-FileCopyrightText = "2014-2016 OpenDevise Inc. and the Asciidoctor Project"
27+
SPDX-License-Identifier = "MIT"
28+
29+
[[annotations]]
30+
path = "config/khronos.css"
31+
precedence = "aggregate"
32+
SPDX-FileCopyrightText = "2013 Dan Allen"
33+
SPDX-License-Identifier = "MIT"
34+
35+
[[annotations]]
36+
path = "config/fonts/**"
37+
precedence = "aggregate"
38+
SPDX-FileCopyrightText = "2019 M+ Fonts Project"
39+
SPDX-License-Identifier = "LicenseRef-MPLUS"
40+
41+
[[annotations]]
42+
path = "scripts/htmldiff/htmldiff.pl"
43+
precedence = "aggregate"
44+
SPDX-FileCopyrightText = ["1998-2006 MACS, Inc.", "2007 SiSco, Inc."]
45+
SPDX-License-Identifier = "MIT"
46+
47+
[[annotations]]
48+
path = ["**.json", "scripts/vuidCounts.py", "config/chunkindex/addscript.**"]
49+
precedence = "aggregate"
50+
SPDX-FileCopyrightText = "2020-2026 The Khronos Group Inc."
51+
SPDX-License-Identifier = "Apache-2.0"
52+
53+
[[annotations]]
54+
path = "config/copyright-spec.adoc"
55+
precedence = "aggregate"
56+
SPDX-FileCopyrightText = "2014-2026 The Khronos Group Inc"
57+
SPDX-License-Identifier = "LicenseRef-KhronosSpecCopyright"
58+
59+
[[annotations]]
60+
path = "scripts/asciidoctor-chunker/**"
61+
precedence = "aggregate"
62+
SPDX-FileCopyrightText = "2021 Wataru Shito (@waterloo_jp)"
63+
SPDX-License-Identifier = "MIT"
64+
65+
[[annotations]]
66+
path = ".gitlab/merge_request_templates/extensiontemplate.md"
67+
precedence = "aggregate"
68+
SPDX-FileCopyrightText = "2026 The Khronos Group Inc"
69+
SPDX-License-Identifier = "CC-BY-4.0"

0 commit comments

Comments
 (0)