make update/verify commands scripts

Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2023-06-24 16:20:40 -07:00
parent 3d252cf8c0
commit 3835c529e3
3 changed files with 20 additions and 20 deletions

View file

@ -4,30 +4,14 @@ This is a fork of [vulkan-headers](https://github.com/KhronosGroup/Vulkan-Header
## Updating
To update this repository, we run the following:
```sh
git remote add upstream https://github.com/KhronosGroup/Vulkan-Headers || true
git fetch upstream
git merge upstream/main --strategy ours
```
To update this repository, run `./update.sh` followed by `./verify.sh` to verify the repository contents.
## Verifying repository contents
For supply chain security reasons (e.g. to confirm we made no patches to the code) you can verify the contents of this repository by adding the upstream version as a remote:
For supply chain security reasons (e.g. to confirm we made no patches to the code) we provide a `git diff` command you can run to verify the contents of this repository:
```sh
git remote add upstream https://github.com/KhronosGroup/Vulkan-Headers || true
git fetch upstream
./verify.sh
```
And then comparing using `git diff` with some options to _exclude deleted files_, and exclude `README.md`, `build.zig`, and `.gitignore` from the diff:
```sh
git diff $(git merge-base origin/main upstream/main)..origin/main \
--diff-filter=d \
':(exclude)README.md' \
':(exclude)build.zig' \
':(exclude).gitignore' \
':(exclude)stub.c'
```
If nothing is printed, there is no diff. Deleted files, and changes to `README.md`, `build.zig`, `.github` CI files and `.gitignore` are ignored.

6
update.sh Executable file
View file

@ -0,0 +1,6 @@
#!/usr/bin/env bash
set -euo pipefail
git remote add upstream https://github.com/KhronosGroup/Vulkan-Headers || true
git fetch upstream
git merge upstream/main --strategy ours

10
verify.sh Executable file
View file

@ -0,0 +1,10 @@
#!/usr/bin/env bash
set -euo pipefail
git diff $(git merge-base origin/main upstream/main)..origin/main \
--diff-filter=d \
':(exclude)README.md' \
':(exclude)build.zig' \
':(exclude).github' \
':(exclude).gitignore' \
':(exclude)stub.c'