From a708a37a7aadfce73fbd4cbe84faa33504f5eee8 Mon Sep 17 00:00:00 2001 From: Jon Leech Date: Fri, 17 Apr 2026 02:33:03 +0100 Subject: [PATCH 1/3] Update CI to actions/checkout@v5 per Actions complaint. Update REUSE to REUSE.toml exception file instead of .reuse/dep5. --- REUSE.toml | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 REUSE.toml diff --git a/REUSE.toml b/REUSE.toml new file mode 100644 index 000000000..ac59837c4 --- /dev/null +++ b/REUSE.toml @@ -0,0 +1,69 @@ +version = 1 +SPDX-PackageName = "Vulkan-Docs" +SPDX-PackageDownloadLocation = "https://github.com/KhronosGroup/Vulkan-Docs" + +[[annotations]] +path = ["images/**.svg", "config/chunkindex/custom.patch", "config/CI/**", "config/**/docinfo-header.html", "build_tests/expectations/**", "build_tests/images/**.svg", "images/proposals/**.svg"] +precedence = "aggregate" +SPDX-FileCopyrightText = "2015-2026 The Khronos Group Inc." +SPDX-License-Identifier = "CC-BY-4.0" + +[[annotations]] +path = "katex/**" +precedence = "aggregate" +SPDX-FileCopyrightText = "2013-2019 Khan Academy and other contributors" +SPDX-License-Identifier = "MIT" + +[[annotations]] +path = "config/chunkindex/lunr.js" +precedence = "aggregate" +SPDX-FileCopyrightText = "2019 Oliver Nightingale" +SPDX-License-Identifier = "MIT" + +[[annotations]] +path = "config/optimize-pdf" +precedence = "aggregate" +SPDX-FileCopyrightText = "2014-2016 OpenDevise Inc. and the Asciidoctor Project" +SPDX-License-Identifier = "MIT" + +[[annotations]] +path = "config/khronos.css" +precedence = "aggregate" +SPDX-FileCopyrightText = "2013 Dan Allen" +SPDX-License-Identifier = "MIT" + +[[annotations]] +path = "config/fonts/**" +precedence = "aggregate" +SPDX-FileCopyrightText = "2019 M+ Fonts Project" +SPDX-License-Identifier = "LicenseRef-MPLUS" + +[[annotations]] +path = "scripts/htmldiff/htmldiff.pl" +precedence = "aggregate" +SPDX-FileCopyrightText = ["1998-2006 MACS, Inc.", "2007 SiSco, Inc."] +SPDX-License-Identifier = "MIT" + +[[annotations]] +path = ["**.json", "scripts/vuidCounts.py", "config/chunkindex/addscript.**"] +precedence = "aggregate" +SPDX-FileCopyrightText = "2020-2026 The Khronos Group Inc." +SPDX-License-Identifier = "Apache-2.0" + +[[annotations]] +path = "config/copyright-spec.adoc" +precedence = "aggregate" +SPDX-FileCopyrightText = "2014-2026 The Khronos Group Inc" +SPDX-License-Identifier = "LicenseRef-KhronosSpecCopyright" + +[[annotations]] +path = "scripts/asciidoctor-chunker/**" +precedence = "aggregate" +SPDX-FileCopyrightText = "2021 Wataru Shito (@waterloo_jp)" +SPDX-License-Identifier = "MIT" + +[[annotations]] +path = ".gitlab/merge_request_templates/extensiontemplate.md" +precedence = "aggregate" +SPDX-FileCopyrightText = "2026 The Khronos Group Inc" +SPDX-License-Identifier = "CC-BY-4.0" From cfa14b0befc20a48f7e5c24e1660361358ef8fdb Mon Sep 17 00:00:00 2001 From: Jon Leech Date: Fri, 17 Apr 2026 02:34:47 +0100 Subject: [PATCH 2/3] And include changed files, not just the new one :-( --- .github/workflows/CI.yml | 20 ++++++++--------- .reuse/dep5 | 48 ---------------------------------------- README.adoc | 1 + 3 files changed, 11 insertions(+), 58 deletions(-) delete mode 100644 .reuse/dep5 diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index c05ea77bc..817e1cf79 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -31,7 +31,7 @@ jobs: container: khronosgroup/docker-images@sha256:f1ca671f3bdb10ad49e238b9bf28853088a21af49504498fc9084c9b4fea4762 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - name: REUSE license checker run: reuse lint @@ -46,7 +46,7 @@ jobs: # This causes 'fatal: detected dubious ownership in repostory' and # failure to run the checks, although it is not actually propagated # back to the Makefile as errors. - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - name: Internal self-test of the check_spec_links script run: pytest test*.py working-directory: scripts @@ -70,7 +70,7 @@ jobs: # This only runs on merge requests where CI_COMMIT_BRANCH is defined, and is # a valid extension name, or is mapped to one in an exception list in # scripts/testSpecVersion.py - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - run: | echo "Branch name is ${{github.ref_name}}" python3 scripts/testSpecVersion.py -branch ${{github.ref_name}} -test -build @@ -81,7 +81,7 @@ jobs: container: khronosgroup/docker-images@sha256:f1ca671f3bdb10ad49e238b9bf28853088a21af49504498fc9084c9b4fea4762 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - run: ./testBuild spec-core: @@ -90,7 +90,7 @@ jobs: container: khronosgroup/docker-images@sha256:f1ca671f3bdb10ad49e238b9bf28853088a21af49504498fc9084c9b4fea4762 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - run: ./makeSpec -clean -spec core -genpath gencore QUIET= -j${nproc} -Otarget html spec-generate: @@ -99,7 +99,7 @@ jobs: container: khronosgroup/docker-images@sha256:f1ca671f3bdb10ad49e238b9bf28853088a21af49504498fc9084c9b4fea4762 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - name: Validate the XML before building anything using it run: make -C xml validate - name: Build the ratified-only spec, to catch incorrect ifdef errors affecting ratification submissions @@ -130,7 +130,7 @@ jobs: continue-on-error: true steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 # Generate the vulkan C++ header (vulkan.hpp) # Failure (should be) allowed, for now - name: Download generated spec @@ -166,7 +166,7 @@ jobs: continue-on-error: true steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - name: Sparse/shallow clone of CTS GitHub repository to pull only relevant parts run: | git clone --sparse --depth 1 --single-branch --branch main https://github.com/KhronosGroup/VK-GL-CTS.git @@ -190,7 +190,7 @@ jobs: needs: spec-generate steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - name: Download generated files uses: actions/download-artifact@v4 with: @@ -215,7 +215,7 @@ jobs: cpp_standard: [c++11, c++14, c++17, c++20, c++23] steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - name: Download generated spec uses: actions/download-artifact@v4 with: diff --git a/.reuse/dep5 b/.reuse/dep5 deleted file mode 100644 index 306cba7d4..000000000 --- a/.reuse/dep5 +++ /dev/null @@ -1,48 +0,0 @@ -Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ -Upstream-Name: Vulkan-Docs -Source: https://github.com/KhronosGroup/Vulkan-Docs - -Files: images/*.svg config/chunkindex/custom.patch config/CI/* config/*/docinfo-header.html build_tests/expectations/* build_tests/images/*.svg images/proposals/*.svg -Copyright: 2015-2026 The Khronos Group Inc. -License: CC-BY-4.0 - -Files: katex/* -Copyright: 2013-2019 Khan Academy and other contributors -License: MIT - -Files: config/chunkindex/lunr.js -Copyright: 2019 Oliver Nightingale -License: MIT - -Files: config/optimize-pdf -Copyright: 2014-2016 OpenDevise Inc. and the Asciidoctor Project -License: MIT - -Files: config/khronos.css -Copyright: 2013 Dan Allen -License: MIT - -Files: config/fonts/* -Copyright: 2019 M+ Fonts Project -License: LicenseRef-MPLUS - -Files: scripts/htmldiff/htmldiff.pl -Copyright: 1998-2006 MACS, Inc. - 2007 SiSco, Inc. -License: MIT - -Files: *.json scripts/vuidCounts.py config/chunkindex/addscript.* -Copyright: 2020-2026 The Khronos Group Inc. -License: Apache-2.0 - -Files: config/copyright-spec.adoc -Copyright: 2014-2026 The Khronos Group Inc -License: LicenseRef-KhronosSpecCopyright - -Files: scripts/asciidoctor-chunker/* -Copyright: 2021 Wataru Shito (@waterloo_jp) -License: MIT - -Files: .gitlab/merge_request_templates/extensiontemplate.md -Copyright: 2026 The Khronos Group Inc -License: CC-BY-4.0 diff --git a/README.adoc b/README.adoc index 0334f033b..d24fc2d6b 100644 --- a/README.adoc +++ b/README.adoc @@ -24,6 +24,7 @@ CONTRIBUTING.adoc Requirements for external contributions to the repository COPYING.adoc Copyright and licensing information CODE_OF_CONDUCT.adoc Code of Conduct LICENSE.adoc Summary of licenses used by files in the repository +REUSE.toml License exceptions for the REUSE tool ChangeLog.adoc Change log summary for each public Vulkan spec update ChangeLogSC.adoc Change log summary for each public Vulkan SC spec update Makefile, make* Makefile and helper build scripts (see BUILD.adoc) From 56a48e70c45b132593a2de014e3b58d720938cf3 Mon Sep 17 00:00:00 2001 From: Jon Leech Date: Fri, 17 Apr 2026 02:56:22 +0100 Subject: [PATCH 3/3] Update upload/download-artifact actions --- .github/workflows/CI.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 817e1cf79..d512d8f26 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -117,7 +117,7 @@ jobs: # Make a single tarball to upload instead run: tar -cvf spec-outputs.tar gen/ genrat/ - name: Archive generated spec - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: spec-outputs path: spec-outputs.tar @@ -134,7 +134,7 @@ jobs: # Generate the vulkan C++ header (vulkan.hpp) # Failure (should be) allowed, for now - name: Download generated spec - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v8 with: name: spec-outputs - name: Unpack generated spec @@ -152,7 +152,7 @@ jobs: cmake --build build --parallel cp vulkan/*.hpp ${SPEC_DIR}/gen/include/vulkan/ - name: Upload generated hpp - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: hpp-outputs path: gen/include/ @@ -192,7 +192,7 @@ jobs: steps: - uses: actions/checkout@v5 - name: Download generated files - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v8 with: name: spec-outputs - name: Unpack generated spec @@ -217,13 +217,13 @@ jobs: steps: - uses: actions/checkout@v5 - name: Download generated spec - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v8 with: name: spec-outputs - name: Unpack generated spec run: tar -xvf spec-outputs.tar - name: Download generated hpp - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v8 with: name: hpp-outputs path: gen/include/