Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions .github/workflows/update_bindings_and_push_to_vulkan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ on:
description: "Optional Vulkan-Docs tag (for example v1.4.362)"
required: false
type: string
force_regenerate:
description: "Regenerate the already-published registry tag after a generator fix"
required: false
default: false
type: boolean

permissions:
contents: read
Expand All @@ -26,11 +31,13 @@ jobs:
outputs:
requested: ${{ steps.versions.outputs.requested }}
changed: ${{ steps.versions.outputs.changed }}
branch: ${{ steps.versions.outputs.branch }}
steps:
- uses: actions/checkout@v7
- id: versions
env:
REQUESTED_VERSION: ${{ inputs.vk_docs_version }}
FORCE_REGENERATE: ${{ inputs.force_regenerate }}
TARGET_VERSION_URL: https://raw.githubusercontent.com/antono2/vulkan/master/VERSION
run: |
set -euo pipefail
Expand All @@ -49,10 +56,18 @@ jobs:
exit 1
}
changed=true
[[ "$current" == "$requested" ]] && changed=false
branch="generated/$requested"
if [[ "$current" == "$requested" ]]; then
changed=false
if [[ "$FORCE_REGENERATE" == true ]]; then
changed=true
branch="compat/generated-$requested"
fi
fi
echo "requested=$requested" >> "$GITHUB_OUTPUT"
echo "changed=$changed" >> "$GITHUB_OUTPUT"
echo "Current: $current; requested: $requested; update required: $changed"
echo "branch=$branch" >> "$GITHUB_OUTPUT"
echo "Current: $current; requested: $requested; update required: $changed; branch: $branch"

generate:
needs: versions
Expand Down Expand Up @@ -130,7 +145,7 @@ jobs:
path: generated
- name: Commit generated module to a release branch
env:
BRANCH_NAME: generated/${{ needs.versions.outputs.requested }}
BRANCH_NAME: ${{ needs.versions.outputs.branch }}
run: |
set -euo pipefail
test -f c/volk.c.v
Expand All @@ -157,7 +172,7 @@ jobs:
fi
- name: Open or update pull request
env:
BRANCH_NAME: generated/${{ needs.versions.outputs.requested }}
BRANCH_NAME: ${{ needs.versions.outputs.branch }}
GH_TOKEN: ${{ secrets.PUSH_VULKAN }}
RELEASE_VERSION: ${{ needs.versions.outputs.requested }}
run: |
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ validates them with V, and opens a generated pull request in
creates the matching immutable version tag after the target repository's
required checks pass.

When the registry tag is already published but the generator itself needs a
compatibility correction, run the workflow manually with `force_regenerate`.
It opens a `compat/generated-<tag>` pull request without changing `VERSION` or
using the release-only `generated/*` branch namespace.

`publish-compatibility-tags.yml` is a manual maintenance workflow for old
registry releases whose original generated layout is not accepted by current
V. It publishes new `+vcompat.N` tags and never rewrites the historical tags.
Loading