Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add notice descriptions to HTML report #1447

Merged
merged 36 commits into from
May 26, 2023

Conversation

briandonahue
Copy link
Collaborator

Summary:

Closes #1364. This PR depends on #1433 being merged first, so is initially submitted as a draft PR.

Add notice descriptions for each notice to the HTML report. Converts markdown comment to HTML.

Expected behavior:

Should include the specific description for each notice in the report

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)
image image

Attached are zip files output for 2 different reports. View the report.html in your browser after unzipping.

alhambra.zip
westchester.zip

@github-actions
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1428 sources (~0 %) are corrupted.
Commit: 55a20a4
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@briandonahue
Copy link
Collaborator Author

Took a stab at adding the column descriptions too:
image

Updated zips attached with report.html:

alhambra.zip
westchester.zip

@github-actions
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1428 sources (~0 %) are corrupted.
Commit: c643723
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@briandonahue briandonahue self-assigned this May 24, 2023
@briandonahue briandonahue marked this pull request as ready for review May 25, 2023 16:22
@briandonahue
Copy link
Collaborator Author

@davidgamez @isabelle-dr Since #1433 has been merged, this one is now ready for review!

@isabelle-dr
Copy link
Contributor

The column descriptions are such a nice addition :)
A quick change request related to the user experience: can we change the text "Please find this notice description here" to "You can see more about this notice here", since now the description is included in the report?

@github-actions
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 1 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 1 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1428 sources (~0 %) are corrupted.
Commit: c597c8e
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@briandonahue
Copy link
Collaborator Author

briandonahue commented May 25, 2023

A quick change request related to the user experience: can we change the text "Please find this notice description here" to "You can see more about this notice here", since now the description is included in the report?

@isabelle-dr done!

image

@github-actions
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1428 sources (~0 %) are corrupted.
Commit: a79c9a8
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

Copy link
Member

@davidgamez davidgamez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done!

@davidgamez davidgamez merged commit 11cae71 into master May 26, 2023
333 checks passed
@davidgamez davidgamez deleted the issue/1364/rule-descriptions branch May 26, 2023 13:33
@briandonahue briandonahue mentioned this pull request May 30, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add the rule descriptions directly in the validation report.
4 participants