LUNARA AURENIX

[vyragootoglobal-web]

Select Topic Area

Question

GitHub Feature Area

Actions

Body

"Hello Community, I am trying to understand how to ensure that the output logs from my GitHub Actions workflows are easily readable by screen readers. Specifically, when using custom scripts that output tables or complex data structures, how can I format them to comply with accessibility standards? Are there any recommended practices or existing actions to improve the accessibility of workflow run summaries or logging details for users with visual impairments? Thank you for any guidance."

[Ashjha75]

It can be challenging to make GitHub Actions logs accessible, but the following tips are very helpful:

1. Keep it simple – Screen readers dislike complicated things like tables. Instead, try lists or key-value:

Name of Test: Successful Build Step: Finalized 

2. Make use of headings and groups – GitHub's ::group::/::endgroup:: make sections more navigable and collapsible:

echo"::group::Build Summary"echo"Tests Passed: 10"echo"::endgroup::"

3. Workflow summaries – $GITHUB_STEP_SUMMARY allows markdown, so lists, bullet points, and headings make reports much easier to read.

4. Avoid decorations – Emojis, pipes, and additional formatting can be confusing to screen readers.

Essentially, maintain linear and semantic logs. This enables everyone to read them, including those who use screen readers.

[Luvvydev]

GitHub exposes the variable GITHUB_STEP_SUMMARY. You can write structured markdown to it. That summary is rendered and is much friendlier to assistive tech than the raw log.