Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
eye

GitHub Action

Accessibility alt text bot

v1.0.0

Accessibility alt text bot

eye

Accessibility alt text bot

This action will check a repos issue, discussion, or PR for correct alt text usage

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Accessibility alt text bot

uses: github/[email protected]

Learn more about this action in github/accessibility-alt-text-bot

Choose a version

Accessibility-alt-text-bot

An action to remind users to add alt text to their issue descriptions and comments.

How to add this action to your repo

Copy this workflow into any repo you want the accessibility-alt-text-bot to run in.

name: Test Accessibility-alt-text-bot
on: 
  issues:
    types: [opened, edited]
  pull_request:
    types: [opened, edited]
  issue_comment:
    types: [created, edited]

jobs:
  accessibility_alt_text_bot:
    name: Check alt text is set on issue or pull requests
    runs-on: ubuntu-latest
    if: ${{ github.event.issue || github.event.pull_request && github.event.comment.user.login != 'accessibility-bot' }}
    steps:
      - name: Get private action 'github/accessibility-alt-text-bot'
        uses: github/accessibility-alt-text-bot

Action stability

To ensure you stay on a stable version of this action consider locking the action to a specific version.

       uses: github/accessibility-alt-text-bot@4a94d0359143b44dab2e392616a02f88c30329df

Replace the ref value with any commit hash.

License

This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.

Maintainers

See CODEOWNERS

Support

TODO: Be explicit about support expectations.

Acknowledgement

Please read Contributing Guide for more information.