action-vpat-publish

GitHub Action that publishes a VPAT report to a target repository

Example workflow

on:
  push:
    branches:
      - main
    paths:
      - 'vpats/*'

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout my product repo
        uses: actions/checkout@v3

      - name: Convert most recent VPAT to HTML
        uses: dequelabs/action-vpat-to-html@main
        id: vpat-to-html
        with:
          product-name: 'My Product'
          vpat-location: vpats

      - name: Write HTML to file
        run: echo -e ${{ steps.vpat-to-html.outputs.stringified-html }} > my-vpat.html

      - name: Publish VPAT to target repository
        uses: dequelabs/action-vpat-publish@main
        with:
          target-repo-github-token: ${{ secrets.PUBLISH_TARGET_GITHUB_TOKEN }}
          target-repo: <org-name>/<repo-name>
          product-id: my-product
          vpat-file: my-vpat.html

Inputs

Name	Description	Default
target-repo-base-branch	The base branch of the target repository.	main
target-repo-github-token	GitHub token to access the target repository.
target-repo	The GitHub repository to which the VPAT should be published.
target-repo-vpat-directory	Directory where the VPAT should be published in the target repository.	static/vpats
product-id	Brief token that identifies your product. If publishing to the docs site, this should match the product ID used there.
vpat-file	The HTML file containing the VPAT.

Developer notes

• The compiled dist/ directory is committed to the main branch by running yarn build locally and committing the changes. The pre-commit hook should do this for you.

Testing

To test your changes, push a commit to the remote repository and manually trigger the Test workflow on the desired branch using the workflow dispatch feature in the GitHub web interface.

After the workflow has run, verify that the workflow successfully created a pull request called "Update VPAT for test" in this repository. Next, verify that the contents of the pull request are as expected - i.e., the test VPAT content added to vpats/test.html.

After verifying the test results, close the pull request (do not merge). This ensures that future tests will not be affected by the test VPAT content.