aria-practices icon indicating copy to clipboard operation
aria-practices copied to clipboard

Update coverage report script to process new content tree and put output into about (Issue 2418 task 9)

Open alflennik opened this issue 3 years ago • 1 comments

See https://github.com/w3c/aria-practices/issues/2418 for more information about the task.

alflennik avatar Aug 29 '22 20:08 alflennik

@mcking65 I made the changes you requested. About whether to merge the PR now or wait, I think since the coverage report is currently working my preference is to merge this PR now and do a separate PR addressing the repercussions after the aria-practices.html file is fully removed.

alflennik avatar Sep 26 '22 21:09 alflennik

@mcking65 Thanks for the review! You are right about the broken links, and that is now fixed; it occurred when I updated the directory of the coverage report.

About the differences in report content, the reason for that, I think, is that the coverage report GitHub action seems to be disabled and has been disabled for some time (around a year?). Here is a link to the page where the script is marked as disabled.

alflennik avatar Oct 18 '22 20:10 alflennik

@alflennik wrote:

@mcking65 Thanks for the review! You are right about the broken links, and that is now fixed; it occurred when I updated the directory of the coverage report.

Awesome, thank you!!

About the differences in report content, the reason for that, I think, is that the coverage report GitHub action seems to be disabled and has been disabled for some time (around a year?). Here is a link to the page where the script is marked as disabled.

I created branch test-coverage-report from tip of main to test this hypothesis. In that branch, I ran scripts/coverage-report.js against the content in main. That version of the script is listing guidance that is not being listed by the script in move-examples-9.

Compare to /coverage/index.html in test-coverage-report.

Here are two examples of differences that need to be resolved.

Roles with No Guidance or Examples:

  • 29 in the test branch
  • 31 in the move-examples-9 branch, including presentation and tooltip, both of which have guidance in the move-examples-9 content tree that should be listed.

Roles with at Least One Guidance or Example:

  • 13 in the test-coverage branch
  • 17 in the move-examples-9 branch: there are more here because several roles should be listed in the 2 or more table, e.g., alert and cell have guidance in the move-examples-9 branch that is not listed.

mcking65 avatar Oct 24 '22 13:10 mcking65

The inaccurate coverage numbers were a great catch @mcking65, and thank you for the thorough review. Also thank you for running the coverage report on another branch, having that for reference came in handy. After investigating I found that moving the practices into their own files was not something I had accounted for, because I had opened the PR before that change was made. Now I've updated this branch to load the practices from their own files and I confirmed that the coverage levels are equivalent and that also all the links work on the coverage report.

alflennik avatar Oct 26 '22 19:10 alflennik