v5.0.0

[emmambd]

Highlights

Reducing the noisiness of errors

There have been repeated issues with the sensitivity of
trip_distance_exceeds_shape_distanceand equal_shape_distance_diff_coordinates. No more! We did an extensive review of real life GTFS data from the Mobility Database and decided on thresholds for these two errors. Now data producers will only see these errors when they’re a significant issue for data quality. Below the thresholds, these issues will generate a warning instead.

Breaking changes: JSON report improvements

• Issue #1652: Use ISO_ZONED_DATE_TIME for validatedAt field to be machine readable.
• Issue #1685 Change gtfsComponents label to gtfsFeatures.

Notice changes

• equal_shape_distance_diff_coordinates: Error is triggered when there's 1.11 metres or more distance between the different shape points. Discussion here.
• trip_distance_exceeds_shape_distance: Error is triggered when there's 11.1 metres or more distance between the last stop point and the last shape point. Discussion here.
• stop_without_zone_id changed from 🔴 ERROR to ⚪ INFO and updated so it is only triggered when there are route-based fare related fields in fare_rules.txt . Discussed in the spec in Clarify stops.zone_id conditional requirement for route-based fare_rules google/transit#432.

New notices

• route_networks_specified_in_more_than_one_file: New 🔴 ERROR for Fares v2 data. Added to spec in [GTFS-Fares v2] Add networks.txt & route_networks.txt google/transit#405.
• equal_shape_distance_diff_coordinates_distance_below_threshold: New 🟡 WARNING that is triggered when the distance between the different shape points is less than 1.11 metres.
• trip_distance_exceeds_shape_distance_below_threshold: New 🟡 WARNING that is triggered when the distance between the last stop point and the last shape point is less than 11.1 metres.

Impacts on existing data

You can find the impact of this release on all existing datasets we have in the Mobility Database in this spreadsheet.

Other notable improvements

• "Error authorizing upload" bug fix on the Web UI
• Allow the validator to accept a "time of validation" argument in the cli
• Generate new CLI package installers on each merge to master
• Add outstanding GTFS features to the validator summary report. Full list of features here.

New Contributors

• @michaelandrewkearney made their first contribution in fix: make stop_without_zone_id conditional on fare rule type (#1663) #1693

PR List

• docs: Update NOTICE_MIGRATION.md by @emmambd in docs: Update NOTICE_MIGRATION.md #1599
• Docs: Add mention to update version number on gtfs.org by @isabelle-dr in Docs: Add mention to update version number on gtfs.org #1600
• feat: Support injection of arbitrary types via ValidationContext by @aababilov in feat: Support injection of arbitrary types via ValidationContext #1607
• fix: Add label to step that creates an issue by @fredericsimard in fix: Add label to step that creates an issue #1610
• fix: cypress error scenario on downloading rules definitions file by @davidgamez in fix: cypress error scenario on downloading rules definitions file #1617
• feat: Update references to Dataset Publishing Guidelines from 2023-11-17 — 1 new commit(s) made to reference.md in Google Transit's repo #1601 by @emmambd in feat: Update references to Dataset Publishing Guidelines from #1601  #1609
• Update release process so we run analytics before release is launched by @emmambd in Update release process so we run analytics before release is launched #1612
• fix: validator version displayed in validator report summary by @jcpitre in fix: validator version displayed in validator report summary #1627
• fix: Correct links to rule documentation by adding -rule by @bradyhunsaker in fix: Correct links to rule documentation by adding -rule #1629
• fix: decreasing_or_equal_stop_time_distance includes prevShapeDistTraveled by @cka-y in fix: decreasing_or_equal_stop_time_distance includes prevShapeDistTraveled #1631
• feat: Update documentation to include code snippet examples for using the validator as a library #1619 Added a bit of documentation to refer to gtfs-validator-example. by @jcpitre in feat: #1619 Added a bit of documentation to refer to gtfs-validator-example. #1635
• fix: Feed generates error to authorize upload by @davidgamez in fix: Feed generates error to authorize upload #1633
• refactor: Replace CurrentDateTime with DateForValidation and use LocalDate by @bradyhunsaker in refactor: Replace CurrentDateTime with DateForValidation and use LocalDate #1636
• docs: Update PULL_REQUEST_TEMPLATE.md by @emmambd in docs: Update PULL_REQUEST_TEMPLATE.md #1622
• fix: authorize upload error on create job endpoint by @davidgamez in fix: authorize upload error on create job endpoint #1642
• fix: Corrected a problem where the version was null in the desktop version. by @jcpitre in fix: Corrected a problem where the version was null in the desktop version. #1643
• feat: Add an argument for the cli (--date) that specifies the date to use during verification. by @bradyhunsaker in feat: Add an argument for the cli (--date) that specifies the date to use during verification. #1628
• fix: Corrected a problem where code was not multithread safe by @jcpitre in fix: Corrected a problem where code was not multithread safe #1653
• Feat: 1640 add remaining gtfs features to the validator by @qcdyx in Feat: 1640 add remaining gtfs features to the validator #1656
• feat: removed route name and agency information components by @qcdyx in feat: removed route name and agency information components #1659
• Minor documentation changes by @jcpitre in Minor documentation changes #1658
• feat: added GtfsNetworkSchema by @qcdyx in feat: added GtfsNetworkSchema #1660
• feat: Added features document. Some corrections to components presence by @jcpitre in feat: Added features document. Some corrections to components presence #1662
• fix: prevent exception raised when serviceId is missing from calendar file by @davidgamez in fix: prevent exception raised when serviceId is missing from calendar file #1646
• Fix: replace GitRunners with GitHub's own runners by @fredericsimard in Fix: replace GitRunners with GitHub's own runners #1664
• Fix: replaced Gitrunners with GitHub's own servers by @fredericsimard in Fix: replaced Gitrunners with GitHub's own servers #1673
• fix: reformatted doc using HTML table format by @qcdyx in fix: reformatted doc using HTML table format #1669
• fix: update gradle wrapper by @qcdyx in fix: update gradle wrapper #1677
• feat: generated CLI package installer by @cka-y in feat: generated CLI package installer #1680
• feat: filter out acceptance tests from validator usage report by @cka-y in feat: filter out acceptance tests from validator usage report #1683
• chore: add skip version check to the master build by @davidgamez in chore: add skip version check to the master build #1684
• feat: validation rules for networks and route_networks by @cka-y in feat: validation rules for networks and route_networks #1671
• fix: cypress tests pointing to production are triggered on PRs checks by @davidgamez in fix: cypress tests pointing to production are triggered on PRs checks #1687
• feat: 1651 web validator retries with bad zip file 2 by @qcdyx in feat: 1651 web validator retries with bad zip file 2 #1686
• fix: table not properly rendered in notices by @cka-y in fix: table not properly rendered in notices #1695
• feat: used the standard date time formatter by @qcdyx in feat: used the standard date time formatter #1691
• feat: replace GTFS Components language to GTFS features by @cka-y in feat: replace GTFS Components language to GTFS features #1696
• feat: threshold of 1.11m on equal_shape_distance_diff_coordinates by @cka-y in feat: threshold of 1.11m on equal_shape_distance_diff_coordinates #1675
• fix: Added a execution result file by @jcpitre in fix: Added a execution result file #1690
• feat: reformat trip and shape dist validator by @cka-y in feat: reformat trip and shape dist validator #1676
• feat: display ERRORS first on validator documentation by @cka-y in feat: display ERRORS first on validator documentation #1667
• fix: make stop_without_zone_id conditional on fare rule type (Rule change: make stop_without_zone_id conditional on fare rule type #1663) by @michaelandrewkearney in fix: make stop_without_zone_id conditional on fare rule type (#1663) #1693
• fix: correct field name in missing_recommended_field_notice (Wrong fieldName in missing_recommanded_field notice #1574) by @michaelandrewkearney in fix: correct field name in missing_recommended_field_notice (#1574) #1706
• fix: 1707 web validator waits for validation forever by @jcpitre in fix: 1707 web validator waits for validation forever #1711
• docs: update deprecated architecture information by @michaelandrewkearney in docs: update deprecated architecture information #1694
• fix: setting package installer java version to 17.0 by @cka-y in fix: setting package installer java version to 17.0 #1709
• feat: 1689 web validator app consumes execution results json by @davidgamez in feat: 1689 web validator app consumes execution results json #1712
• feat: Add examples table for mixed_case_recommended_field by @emmambd in feat: Add examples table for mixed_case_recommended_field #1708

Full Changelog: v4.2.0...v5.0.0

---

This discussion was created from the release v5.0.0.