For publication / deploy on Thursday March 20, 2025 (#394)

* Update `APG` to `WAI` pipeline workflows to handle desync issues and better reports on errors (#361)

* Fix #219
* Update 'deploy.yml' to use 'w3cgruntbot' as committer
* Update 'pr-create.yml' to force a rebase to happen with main in the case generated branch doesn't have relevant changes; additional error handling coverage with 'create-pr' script
* For consistency, rename 'create-pr' script to 'pr-create'
* Remove unnecessary delete branch action

* Infrastructure: Add case to specially handle conflicts in submodule folder to `pr-create.yml` (#373)

* Add case to specially handle conflicts in submodule folder

* Additional pr-create.yml workflow changes to support submodule conflict resolution (#374)

* Infrastructure: Disable git editor during `git rebase --continue` in `pr-create.yml` (#375)

* Update transformPattern.js to support "patterns/landmarks" (#382)

* Pin ruby 3.3.3 instead of 3.3.x during workflow builds (#384)

* chore: Update `main` with latest changes from `aria-practices`

* Remove use of ytkey (deprecated) (#370)

* Infrastructure: Create `.tracked-html-assets.json`  (#388)

* Create .tracked-html-assets.json to make it easier to account for html assets which don't match with the expected html assets' naming structure

* chore: Update `main` with latest changes from `aria-practices`

* chore: Update `main` with latest changes from `aria-practices`

* chore: Update `main` with latest changes from `aria-practices`

* Update .tracked-html-assets.json (#395)

---------

Co-authored-by: w3cgruntbot <[email protected]>
Co-authored-by: Rémi Bétin <[email protected]>

Author: 3 people

.github/workflows/deploy.yml

@@ -22,7 +22,7 @@ jobs:
     - name: Set up Ruby 3.3
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.3
+        ruby-version: '3.3.3'
         bundler-cache: true
 
     - name: Update git submodules
@@ -36,9 +36,12 @@ jobs:
         node ./scripts/pre-build
 
     - name: Commit changed files and submodule updates
-      uses: stefanzweifel/git-auto-commit-action@v4
+      uses: stefanzweifel/git-auto-commit-action@v5
       with:
-        commit_message: Commit changes
+        commit_user_name: w3cgruntbot
+        commit_user_email: [email protected]
+        commit_author: w3cgruntbot <[email protected]>
+        commit_message: "chore: Update `main` with latest changes from `aria-practices`"
         branch: main
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr-create.yml

@@ -17,16 +17,16 @@ on:
         required: false
 
 jobs:
-  create-pr:
+  pr-create:
     runs-on: ubuntu-latest
 
     steps:
       - name: Get current job and log url
-        uses: Tiryoh/gha-jobid-action@v0
+        uses: Tiryoh/gha-jobid-action@v1
         id: jobs
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          job_name: create-pr
+          job_name: pr-create
 
       - uses: actions/checkout@v4
         with:
@@ -42,29 +42,62 @@ jobs:
       - name: Set up Ruby 3.3
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.3
+          ruby-version: '3.3.3'
 
       - name: Update git submodules
-        if: github.event.inputs.fork_path == 'false'
         run: |
           git submodule update --recursive --remote
           cd _external/aria-practices
+          if [ -n "${{ github.event.inputs.fork_path }}" ] && [ "${{ github.event.inputs.fork_path }}" != 'false' ]; then
+            echo "Found fork: ${{ github.event.inputs.fork_path }}"
+            git remote add fork https://github.com/${{ github.event.inputs.fork_path }}.git
+            git fetch fork
+          fi
           git checkout ${{ github.event.inputs.apg_sha }}
 
-      - name: Update git submodules from fork
-        if: github.event.inputs.fork_path != 'false'
-        run: |
-          git submodule update --recursive --remote
-          cd _external/aria-practices
-          git remote add fork https://github.com/${{ github.event.inputs.fork_path }}.git
-          git fetch fork
-          git checkout ${{ github.event.inputs.apg_sha }}
-
-      - name: Switch to and create/update branch
+      - name: Switch to and create or update branch
         run: |
           # switch to branch if exists or create branch
           git switch apg/${{ github.event.inputs.apg_branch }} 2>/dev/null || git switch -c apg/${{ github.event.inputs.apg_branch }}
 
+      - name: Force rebase the switched branch onto main
+        run: |
+          git config --global user.name "w3cgruntbot"
+          git config --global user.email "[email protected]"
+          git fetch origin main
+          git rebase --force-rebase origin/main || true
+
+          # Handle cases where the aria-practices submodule has conflicts to be handled;
+          # _external/data shouldn't have conflicting changes
+          if [ -d "_external/aria-practices" ] && { [ -f ".git/rebase-apply" ] || [ -d ".git/rebase-merge" ]; }; then
+            echo "Handling submodule conflicts..."
+            cd _external/aria-practices
+
+            # Resolve the conflict
+            git fetch origin
+            git merge origin/main
+
+            # Add resolved submodule from project root
+            cd -
+            git add _external/aria-practices
+
+            # Continue the rebase
+            GIT_EDITOR=true git rebase --continue || true
+
+            # Resolve conflicts for all other conflicting files automatically using 'theirs' from project root
+            git diff --name-only --diff-filter=U | while read -r file; do
+              git checkout --theirs "$file"
+              git add "$file"
+            done
+
+            # Continue the rebase
+            GIT_EDITOR=true git rebase --continue || true
+          else
+            echo "No submodule conflicts detected or no rebase in progress."
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Update site files
         id: update_site_files
         working-directory: ./
@@ -76,19 +109,23 @@ jobs:
 
       - name: Commit changed files and submodule updates
         if: steps.update_site_files.outcome == 'success'
-        uses: stefanzweifel/git-auto-commit-action@v4
+        uses: stefanzweifel/git-auto-commit-action@v5
         with:
-          commit_message: Commit changed files and submodule updates
+          commit_user_name: w3cgruntbot
+          commit_user_email: [email protected]
+          commit_author: w3cgruntbot <[email protected]>
+          commit_message: 'chore: Update branch with latest `${{ github.event.inputs.apg_branch }}` changes and submodule updates'
           branch: apg/${{ github.event.inputs.apg_branch }}
           push_options: '--force'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Create pull request
+      - name: Create or update pull request
         working-directory: ./
         run: |
-          npm install -C scripts/create-pr
-          node ./scripts/create-pr
+          set -e
+          npm install -C scripts/pr-create
+          node ./scripts/pr-create
         env:
           GH_TOKEN: ${{ secrets.W3CGRUNTBOT_TOKEN }}
           APG_SHA: ${{ github.event.inputs.apg_sha }}

.github/workflows/remove-branch.yml

@@ -12,17 +12,24 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - uses: actions/checkout@v4
+
       - name: Check if branch exists
         id: check_if_exists
         run: |
-          OUTPUT=$(git ls-remote --heads https://github.com/${{ github.repository_owner }}/wai-aria-practices.git apg/${{ github.event.inputs.apg_branch }} | wc -l)
-          echo "::set-output name=branch-exists::$(echo $OUTPUT)"
+          BRANCH_EXISTS=$(git ls-remote --heads https://github.com/${{ github.repository_owner }}/wai-aria-practices.git apg/${{ github.event.inputs.apg_branch }} | wc -l)
+          echo "BRANCH_EXISTS=$BRANCH_EXISTS" >> "$GITHUB_OUTPUT"
+
       - name: Clean up generated branch
-        if: ${{ steps.check_if_exists.outputs.branch-exists == '1' }}
-        uses: dawidd6/action-delete-branch@v3
-        with:
-          github_token: ${{ github.token }}
-          branches: apg/${{ github.event.inputs.apg_branch }}
+        if: ${{ steps.check_if_exists.outputs.BRANCH_EXISTS == '1' }}
+        run: |
+          BRANCH_NAME="apg/${{ github.event.inputs.apg_branch }}"
+          git config --global user.name "w3cgruntbot"
+          git config --global user.email "[email protected]"
+          git push origin --delete $BRANCH_NAME
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Report branch already removed
-        if: ${{ steps.check_if_exists.outputs.branch-exists == '0' }}
+        if: ${{ steps.check_if_exists.outputs.BRANCH_EXISTS == '0' }}
         run: echo "Branch already removed"

ARIA/apg/patterns/slider-multithumb/examples/slider-multithumb.md

@@ -12,7 +12,7 @@ permalink: /ARIA/apg/patterns/slider-multithumb/examples/slider-multithumb/
 
 sidebar: true
 
-footer: "      <div class='example-page-footer'>        <p><a href='https://github.com/orgs/w3c/projects/124'>View issues related to this example</a></p>        <p>Page last updated: 12 December 2024</p>      </div>    "
+footer: "      <div class='example-page-footer'>        <p><a href='https://github.com/orgs/w3c/projects/124'>View issues related to this example</a></p>        <p>Page last updated: 12 February 2025</p>      </div>    "
 
 # Context here: https://github.com/w3c/wai-aria-practices/issues/31
 type_of_guidance: APG

ARIA/apg/patterns/treegrid/examples/treegrid-1.md

@@ -12,7 +12,7 @@ permalink: /ARIA/apg/patterns/treegrid/examples/treegrid-1/
 
 sidebar: true
 
-footer: "      <div class='example-page-footer'>        <p><a href='https://github.com/orgs/w3c/projects/117'>View issues related to this example</a></p>        <p>Page last updated: 22 October 2024</p>      </div>    "
+footer: "      <div class='example-page-footer'>        <p><a href='https://github.com/orgs/w3c/projects/117'>View issues related to this example</a></p>        <p>Page last updated: 18 March 2025</p>      </div>    "
 
 # Context here: https://github.com/w3c/wai-aria-practices/issues/31
 type_of_guidance: APG

ARIA/apg/practices/grid-and-table-properties/grid-and-table-properties-practice.md

@@ -158,8 +158,7 @@ if (enableSidebar) document.body.classList.add('has-sidebar');
   aria-rowcount tells assistive technologies the actual size of the grid
   is 463 rows even though only 4 rows are present in the markup.
 -->
-<table role="grid" aria-rowcount="463">
-  aria-label="Student roster for history 101"
+<table role="grid" aria-rowcount="463" aria-label="Student roster for history 101">
   <thead>
     <tr aria-rowindex="1">
       <th>Last Name</th>
@@ -280,8 +279,8 @@ if (enableSidebar) document.body.classList.add('has-sidebar');
             In this example, the first two columns with the student name are shown, but the score columns have been scrolled to show columns 10 through 13.
             Columns 3 through 9 are not visible so are not in the DOM.
           </p>
-          <pre><code>&lt;table role=&quot;grid&quot; aria-rowcount=&quot;463&quot; aria-colcount=&quot;13&quot;&gt;
-  aria-label=&quot;Student grades for history 101&quot;
+          <pre><code>&lt;table role=&quot;grid&quot; aria-rowcount=&quot;463&quot; aria-colcount=&quot;13&quot;
+  aria-label=&quot;Student grades for history 101&quot;&gt;
   &lt;!--
     aria-rowcount and aria-colcount tell assistive technologies
     the actual size of the grid is 463 rows by 13 columns,

ARIA/apg/practices/landmark-regions/landmark-regions-practice.md

@@ -424,7 +424,7 @@ if (enableSidebar) document.body.classList.add('has-sidebar');
 
             <li>If a page includes more than one <code>region</code> landmark, each should have a unique label (see <a href="#aria_lh_step3">Step 3</a> above).</li>
 
-            <li>The <code>region</code> landmark can be used identify content that named landmarks do not appropriately describe.</li>
+            <li>The <code>region</code> landmark can be used to identify content that named landmarks do not appropriately describe.</li>
           </ul>
 
           <section>

_config.yml

@@ -33,8 +33,6 @@ kramwdown:
 highlighter: rouge
 repository: w3c/wai-aria-practices
 
-ytkey: AIzaSyCiZ9uToWu9jb7BTx47NtzCvmGGXKXp8nI
-
 remote_theme: w3c/wai-website-theme
 
 collections: