From bdb8833e167aca2837860903a38044f6aa601ec2 Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Mon, 12 Jun 2023 10:57:27 -0400 Subject: [PATCH 1/9] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 719aaf5..5d037f5 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ jobs: if: ${{ github.event.issue || github.event.pull_request || github.event.discussion }} steps: - name: Get action 'github/accessibility-alt-text-bot' - uses: github/accessibility-alt-text-bot + uses: github/accessibility-alt-text-bot@v1.2.0 # Set to latest ``` ### Action stability @@ -49,7 +49,7 @@ jobs: To ensure you stay on a stable version of this action consider locking the action to a specific version. ```yml - uses: github/accessibility-alt-text-bot@v1.0.0 + uses: github/accessibility-alt-text-bot@v1.2.0 ``` Replace the ref value with any commit hash. From d351030b0d52e3ad420f3f2222112eadae1e5737 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 14 Jun 2023 12:32:48 +0200 Subject: [PATCH 2/9] Rewrite readme --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5d037f5..a5a23db 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,27 @@ # Accessibility-alt-text-bot -This action supports accessible content sharing on GitHub by leaving an automated reminder whenever an image is shared on a GitHub Issue, Pull request, or Discussion without meaningful alternative text (alt text). -Alternative text helps convey the context of the image to those who use assistive technologies such as a screen reader and removes accessibility barriers. +This action reminds users to add a meaningful alternative text to their images. +Alternative text helps users who rely on tools like screen readers, and lowers accessibility barriers. -For guidance on setting alternative text, see [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images). +The action can check: -Images on GitHub default to using the filename as alt text. This action flags when the alt text has not been updated from the default: +- Issues +- Pull Requests +- Discussions + +To learn how to write good alternative text, read [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images). + +Images on GitHub default to using the filename as alt text. +This action flags when the alt text has not been updated from the default: Screenshot of an automated actions comment on a GitHub issue that says, 'Uh oh! @monalisa, the image you shared is missing helpful alt text...' and contains instructions for setting alt text -**Note**: Ordinarily, setting `alt=""` will mark images as decorative. However, GitHub currently renders all images as a link. To avoid rendering links with no names, we recommend always setting alt text on images in GitHub. +> **Note** +> Normally, setting `alt=""` marks images as decorative. But GitHub renders all images as a link. To avoid rendering links with no names, we recommend always setting alt text on images in GitHub. ## How to add this action to your repo -Copy this workflow into any repo you want the accessibility-alt-text-bot to run in. +Copy this workflow into any repo you want the `accessibility-alt-text-bot` to run in: ```yml name: Accessibility-alt-text-bot @@ -46,7 +54,8 @@ jobs: ### Action stability -To ensure you stay on a stable version of this action consider locking the action to a specific version. +We recommend you pin the action to a specific version. +This makes sure you stay on a stable version of this action. ```yml uses: github/accessibility-alt-text-bot@v1.2.0 @@ -56,7 +65,8 @@ 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](./LICENSE.txt) for the full terms. +This project is licensed under the terms of the MIT open source license. +Please refer to [the MIT license file](./LICENSE.txt) for the full terms. ## Maintainers From 75f8917a3f1ac008225dc363fedf97122100f927 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Fri, 16 Jun 2023 13:52:22 +0200 Subject: [PATCH 3/9] Update README.md --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5a23db..cc84577 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ The action can check: To learn how to write good alternative text, read [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images). +## Why you may need this action + Images on GitHub default to using the filename as alt text. This action flags when the alt text has not been updated from the default: @@ -52,7 +54,7 @@ jobs: uses: github/accessibility-alt-text-bot@v1.2.0 # Set to latest ``` -### Action stability +### Pin the action's version for stability We recommend you pin the action to a specific version. This makes sure you stay on a stable version of this action. @@ -66,7 +68,7 @@ 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 [the MIT license file](./LICENSE.txt) for the full terms. +Please read [the MIT license file](./LICENSE.txt) for the full terms. ## Maintainers @@ -78,7 +80,7 @@ TODO: Be explicit about support expectations. ## Acknowledgement -Please read [Contributing Guide](./CONTRIBUTING.md) for more information. +Please read our [Contributing Guide](./CONTRIBUTING.md) for more information. ## Contributors ✨ @@ -102,4 +104,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. +Contributions of any kind welcome! From 727b3811ae7907438094390c1b912eae4cbd67a3 Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Fri, 16 Jun 2023 11:11:01 -0400 Subject: [PATCH 4/9] Update workflow file --- .github/workflows/ci.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e63353b..b00ff1a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,8 +1,8 @@ -name: Run unit tests -on: push - +name: CI +on: [push, pull_request, workflow_dispatch] jobs: - accessibility_alt_text_bot: + tests: + name: Run unit tests runs-on: ubuntu-latest steps: - name: Checkout repo @@ -12,4 +12,3 @@ jobs: run: | ls ./test-flag-alt-text.sh - From 1b5aef84c46a6b114b3effe8d08cfa1e22a702b2 Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Fri, 16 Jun 2023 11:19:31 -0400 Subject: [PATCH 5/9] Update ci.yml --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b00ff1a..7418133 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,5 +1,5 @@ name: CI -on: [push, pull_request, workflow_dispatch] +on: push jobs: tests: name: Run unit tests From 195bb3aa196a4656d007d4d7c09f55404e398436 Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Fri, 16 Jun 2023 11:31:38 -0400 Subject: [PATCH 6/9] Update ci.yml --- .github/workflows/ci.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7418133..0851c76 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,5 +1,9 @@ name: CI -on: push +on: + push: + branches: ["main"] + workflow_dispatch: + pull_request: jobs: tests: name: Run unit tests From b8484e124855b2e20bf7d01dd7fcdc2d536ab906 Mon Sep 17 00:00:00 2001 From: Kendall Gassner Date: Mon, 19 Jun 2023 09:58:07 -0700 Subject: [PATCH 7/9] Add all contributors (#21) * Add @HonkingGoose as a contributor * add_contributorg --- .all-contributorsrc | 10 ++++++++++ README.md | 1 + 2 files changed, 11 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index 12adb40..9f59a61 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -43,6 +43,16 @@ "doc", "infra" ] + }, + { + "login": "HonkingGoose", + "name": "HonkingGoose", + "avatar_url": "https://avatars.githubusercontent.com/u/34918129?v=4", + "profile": "https://github.com/HonkingGoose", + "contributions": [ + "doc", + "a11y" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index cc84577..4f58ed4 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Katie Foster
Katie Foster
🤔 ️️️️♿️ Kendall Gassner
Kendall Gassner
💻 ️️️️♿️ 📖 🚇 Kate Higa
Kate Higa
💻 ️️️️♿️ 📖 🚇 + HonkingGoose
HonkingGoose
📖 From 5d9b99c7628843cb0ce87e3f34cc5be995bc9b7b Mon Sep 17 00:00:00 2001 From: Kendall Gassner Date: Mon, 26 Jun 2023 12:15:18 -0700 Subject: [PATCH 8/9] Update README to be more verbose about what the bot can check (#25) fixes #24 --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4f58ed4..29acb6e 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,12 @@ Alternative text helps users who rely on tools like screen readers, and lowers a The action can check: -- Issues -- Pull Requests -- Discussions +- Issue comments +- Issue descriptions +- Pull Request comments +- Pull Request descriptions +- Discussion comments +- Discussion descriptions To learn how to write good alternative text, read [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images). From b5828a5ec03d5fc67860c0f656f4abca3947cced Mon Sep 17 00:00:00 2001 From: Kendall Gassner Date: Wed, 5 Jul 2023 10:23:10 -0700 Subject: [PATCH 9/9] Flag images without alt text (#26) * Flag images without alt text * add exit on failure * add todo; * uncomment * flag images without alt --- action.yml | 4 +-- flag-alt-text.sh | 23 ++++++++----- test-flag-alt-text.sh | 78 ++++++++++++++++++++++++------------------- 3 files changed, 60 insertions(+), 45 deletions(-) diff --git a/action.yml b/action.yml index e2c6757..5a54ece 100644 --- a/action.yml +++ b/action.yml @@ -59,8 +59,8 @@ runs: Learn more about alt text at [Basic writing and formatting syntax: images on GitHub Docs](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images)." flag="$(flagAltText "$content")" - echo $flag - echo $type + echo "Detected bad alt text: ${flag}" + echo "Event type: $type" if [[ $flag = true ]]; then if [[ $type = pr_comment ]] || [[ $type = pr_description ]]; then diff --git a/flag-alt-text.sh b/flag-alt-text.sh index d9003fb..2eb16f4 100644 --- a/flag-alt-text.sh +++ b/flag-alt-text.sh @@ -1,13 +1,18 @@ #!/bin/bash flagAltText() { - markdownMacOsScreenshotRegex="^.*!\[(Clean|Screen) ?[S|s]hot [0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-9][0-9].*\].*$" - semanticMacOsScreenshotRegex="^.*' - # html - 'image' - 'Screen shot 2020-01-01 at 12.00.00.png' - 'Screen Shot 2020-01-01 at 12.00.00.png' - 'Screenshot 2020-01-01 at 12.00.00.png' - 'CleanShot 2020-01-01 @12x' + # markdown + '![Cleanshot 2020-01-01 at 12.00.00.png]' + '![Clean shot 2020-12-01 @12x]' + "![Clean shot 2020-12-01 @12x]" + "![Screen Shot 2020-01-01 at 12.00.00.png]" + "![Screenshot 2020-01-01 at 12.00.00.png]" + "![image]" + "![Image]" + "![]" + "Check this: ![Image]" + "My awesome ![image]" + 'Check this out: image' + # html + 'image' + '' + "" + "" + '' + '' + 'Screen shot 2020-01-01 at 12.00.00.png' + 'Screen Shot 2020-01-01 at 12.00.00.png' + 'Screenshot 2020-01-01 at 12.00.00.png' + 'CleanShot 2020-01-01 @12x' ) declare -a should_be_false=( - # markdown - "![Screenshot of the new GitHub home page]" - "![Screen shot of Submit button with updated color contrast.]" - "![Image of a cat]" - # html - 'Mona Lisa, the Octocat' - 'Screenshot of the new danger button with a dark red shade' - 'Clean shot of the scenery' + # markdown + "![Screenshot of the new GitHub home page]" + "![Screen shot of Submit button with updated color contrast.]" + "![Image of a cat]" + # html + 'Mona Lisa, the Octocat' + 'Mona Lisa, the Octocat' + 'Screenshot of the new danger button with a dark red shade' + 'Clean shot of the scenery' ) echo "******Expecting true:*******" -for i in "${should_be_true[@]}" -do - echo "Testing: $i" - assert_true "$(flagAltText "$i")" "$i must be true" +for i in "${should_be_true[@]}"; do + echo "Testing: $i" + assert_true "$(flagAltText "$i")" "$i must be true" + if [ $? == 1 ]; then + exit 1 + fi done echo "******Expecting false:*******" -for i in "${should_be_false[@]}" -do - echo "Testing: $i" - assert_false "$(flagAltText "$i")" "$i must be false" +for i in "${should_be_false[@]}"; do + echo "Testing: $i" + assert_false "$(flagAltText "$i")" "$i must be false" + if [ $? == 1 ]; then + exit 1 + fi done -