forked from shader-slang/slang
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'shader-slang:master' into master
- Loading branch information
Showing
86 changed files
with
786 additions
and
458 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| name: Check Table of Contents (comment /regenerate-toc to auto-fix) | ||
|
|
||
| on: | ||
| push: | ||
| branches: [master] | ||
| pull_request: | ||
| branches: [master] | ||
| jobs: | ||
| check-formatting: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - run: ./docs/build_toc.sh --check-only |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| name: Regenerate TOC | ||
| on: | ||
| repository_dispatch: | ||
| types: [regenerate-toc-command] | ||
| jobs: | ||
| regenerate-toc: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout PR branch | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| token: ${{ secrets.SLANGBOT_PAT }} | ||
| repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }} | ||
| ref: ${{ github.event.client_payload.pull_request.head.ref }} | ||
| path: pr-branch | ||
|
|
||
| - name: Checkout target branch | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| token: ${{ secrets.SLANGBOT_PAT }} | ||
| repository: ${{ github.event.client_payload.pull_request.base.repo.full_name }} | ||
| ref: ${{ github.event.client_payload.pull_request.base.ref }} | ||
| path: target-branch | ||
|
|
||
| - name: Regenerate Table of Contents | ||
| id: regen | ||
| run: | | ||
| ./target-branch/docs/build_toc.sh --source ./pr-branch | ||
| - name: Configure Git commit signing | ||
| id: git-info | ||
| run: | | ||
| echo "${{ secrets.SLANGBOT_SIGNING_KEY }}" > "${{runner.temp}}"/signing_key | ||
| chmod 600 "${{runner.temp}}"/signing_key | ||
| git -C pr-branch config commit.gpgsign true | ||
| git -C pr-branch config gpg.format ssh | ||
| git -C pr-branch config user.signingkey "${{runner.temp}}"/signing_key | ||
| bot_info=$(curl -s -H "Authorization: Bearer ${{ secrets.SLANGBOT_PAT }}" \ | ||
| "https://api.github.com/user") | ||
| echo "bot_identity=$(echo $bot_info | jq --raw-output '.login + " <" + (.id|tostring) + "+" + .login + "@users.noreply.github.com>"')" >> $GITHUB_OUTPUT | ||
| echo "bot_name=$(echo $bot_info | jq --raw-output '.login')" >> $GITHUB_OUTPUT | ||
| - name: Create Pull Request | ||
| id: create-pr | ||
| uses: peter-evans/create-pull-request@v7 | ||
| with: | ||
| token: ${{ secrets.SLANGBOT_PAT }} | ||
| path: pr-branch | ||
| commit-message: "regenerate documentation Table of Contents" | ||
| title: "Regenerate documentation ToC for PR #${{ github.event.client_payload.pull_request.number }}" | ||
| body: "Automated ToC generation for ${{ github.event.client_payload.pull_request.html_url }}" | ||
| committer: ${{ steps.git-info.outputs.bot_identity }} | ||
| author: ${{ steps.git-info.outputs.bot_identity }} | ||
| branch: regenerate-toc-${{ github.event.client_payload.pull_request.number }}-${{ github.event.client_payload.pull_request.head.ref }} | ||
| base: ${{ github.event.client_payload.pull_request.head.ref }} | ||
| push-to-fork: ${{ steps.git-info.outputs.bot_name }}/slang | ||
| delete-branch: true | ||
|
|
||
| - name: Comment on PR | ||
| uses: peter-evans/create-or-update-comment@v4 | ||
| if: always() | ||
| with: | ||
| token: ${{ secrets.SLANGBOT_PAT }} | ||
| repository: ${{ github.event.client_payload.github.payload.repository.full_name }} | ||
| issue-number: ${{ github.event.client_payload.pull_request.number }} | ||
| body: | | ||
| ${{ | ||
| steps.regen.conclusion == 'failure' | ||
| && format('❌ Table of Contents generation failed. Please check the [workflow run](https://github.com/{0}/actions/runs/{1})', github.repository, github.run_id) | ||
| || (steps.create-pr.conclusion == 'failure' | ||
| && format('❌ Failed to create regenerate ToC pull request. Please check the [workflow run](https://github.com/{0}/actions/runs/{1})', github.repository, github.run_id) | ||
| || format('🌈 Regenerated Table of Contents, please merge the changes from [this PR]({0})', steps.create-pr.outputs.pull-request-url)) | ||
| }} | ||
| - name: Add reaction | ||
| uses: peter-evans/create-or-update-comment@v4 | ||
| with: | ||
| token: ${{ secrets.SLANGBOT_PAT }} | ||
| repository: ${{ github.event.client_payload.github.payload.repository.full_name }} | ||
| comment-id: ${{ github.event.client_payload.github.payload.comment.id }} | ||
| reactions-edit-mode: replace | ||
| reactions: hooray |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| #!/usr/bin/env bash | ||
| set -e | ||
|
|
||
| script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| project_root="$(dirname "$script_dir")" | ||
| check_only=0 | ||
|
|
||
| show_help() { | ||
| me=$(basename "$0") | ||
| cat <<EOF | ||
| $me: Build table of contents for documentation directories | ||
| Usage: $me [--help] [--source <path>] [--check-only] | ||
| Options: | ||
| --help Show this help message | ||
| --source Path to project root directory (defaults to parent of the script directory) | ||
| --check-only Check if TOC needs updating, exit 1 if changes needed | ||
| EOF | ||
| } | ||
|
|
||
| while [[ "$#" -gt 0 ]]; do | ||
| case $1 in | ||
| -h | --help) | ||
| show_help | ||
| exit 0 | ||
| ;; | ||
| --source) | ||
| project_root="$2" | ||
| shift | ||
| ;; | ||
| --check-only) | ||
| check_only=1 | ||
| ;; | ||
| *) | ||
| echo "unrecognized argument: $1" >&2 | ||
| show_help >&2 | ||
| exit 1 | ||
| ;; | ||
| esac | ||
| shift | ||
| done | ||
|
|
||
| missing_bin=0 | ||
|
|
||
| require_bin() { | ||
| local name="$1" | ||
| if ! command -v "$name" &>/dev/null; then | ||
| echo "This script needs $name, but it isn't in \$PATH" >&2 | ||
| missing_bin=1 | ||
| return | ||
| fi | ||
| } | ||
|
|
||
| require_bin "mcs" | ||
| require_bin "mono" | ||
|
|
||
| if [ "$missing_bin" -eq 1 ]; then | ||
| exit 1 | ||
| fi | ||
|
|
||
| temp_dir=$(mktemp -d) | ||
| trap 'rm -rf "$temp_dir"' EXIT | ||
|
|
||
| docs_dir="$project_root/docs" | ||
|
|
||
| cat >"$temp_dir/temp_program.cs" <<EOL | ||
| $(cat "$script_dir/scripts/Program.cs") | ||
| namespace toc | ||
| { | ||
| class Program | ||
| { | ||
| static int Main(string[] args) | ||
| { | ||
| if (args.Length < 1) | ||
| { | ||
| Console.WriteLine("Please provide a directory path"); | ||
| return 1; | ||
| } | ||
| try | ||
| { | ||
| Builder.Run(args[0]); | ||
| return 0; | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| Console.WriteLine(\$"Error: {ex.Message}"); | ||
| return 1; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| EOL | ||
|
|
||
| if ! mcs -r:System.Core "$temp_dir/temp_program.cs" -out:"$temp_dir/toc-builder.exe"; then | ||
| echo "Compilation of $script_dir/scripts/Program.cs failed" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| for dir in "user-guide" "gfx-user-guide"; do | ||
| if [ -d "$docs_dir/$dir" ]; then | ||
| if [ "$check_only" -eq 1 ]; then | ||
| # Ensure working directory is clean | ||
| if ! git -C "$project_root" diff --quiet "docs/$dir/toc.html" 2>/dev/null; then | ||
| echo "Working directory not clean, cannot check TOC" >&2 | ||
| exit 1 | ||
| fi | ||
| fi | ||
|
|
||
| if ! mono "$temp_dir/toc-builder.exe" "$docs_dir/$dir"; then | ||
| echo "TOC generation failed for $dir" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [ "$check_only" -eq 1 ]; then | ||
| if ! git -C "$project_root" diff --quiet "docs/$dir/toc.html" 2>/dev/null; then | ||
| git -C "$project_root" diff --color "docs/$dir/toc.html" | ||
| git -C "$project_root" checkout -- "docs/$dir/toc.html" 2>/dev/null | ||
| exit 1 | ||
| fi | ||
| fi | ||
| else | ||
| echo "Directory $dir not found" >&2 | ||
| fi | ||
| done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.