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: Extract notice docs from source-code for in-app use and schema export #1365

Merged
merged 8 commits into from
Apr 7, 2023

Conversation

bdferris-v2
Copy link
Collaborator

Summary:

Per discussion in #1324, this PR adds support for extracting documentation from notice source code, to be included as JSON resources bundles in the compiled application. These will be included in the now-expanded JSON schema export feature, including comments, reference links, and hopefully enough info to generate RULES.md from source.

See https://bit.ly/gtfs-validator-notice-documentation for initial design discussion.

  • 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)

@github-actions
Copy link
Contributor

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

@davidgamez
Copy link
Member

@bdferris-v2 let's connect to discuss where the generated documentation can live to make it easily accessible to consumers.

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.

LGTM! 💪

@github-actions
Copy link
Contributor

github-actions bot commented Apr 5, 2023

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

@github-actions
Copy link
Contributor

github-actions bot commented Apr 7, 2023

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

@bdferris-v2 bdferris-v2 merged commit f82bb5d into master Apr 7, 2023
@bdferris-v2 bdferris-v2 deleted the issue/1324/notice_resources branch April 7, 2023 18:20
bradyhunsaker pushed a commit to bradyhunsaker/gtfs-validator that referenced this pull request Apr 25, 2023
…export (MobilityData#1365)

* Initial entry for @GtfsValidationNotice annotation, which will be used to configure and document validation notices in source code.

* Move key annotation and entity interfaces into a new `model` module.  This will allow us to break up some potential circular dependencies with upcoming support for notice documentation generation.

* Initial entry for processor:notices module, with support for documentation extraction for notices.

* Fix test on Windows.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants