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: apply recommended file notice to feed_info #1197

Conversation

KClough
Copy link
Collaborator

@KClough KClough commented Jun 24, 2022

Summary:

Resolves #877

Adds a new annotation for recommended files and applies this annotation to feed_info.txt and shapes.txt.

Expected behavior:

A new validator warning is generated when either feed_info.txt is missing

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)

Here is the sample output from the validator for a data set with missing feed_info.txt:

{
  "notices": [
    {
      "code": "missing_recommended_file",
      "severity": "WARNING",
      "totalNotices": 1,
      "sampleNotices": [
        {
          "filename": "feed_info.txt"
        }
      ]
    }
]}

@KClough KClough changed the title Issue/877/feed info recommended feat: apply recommended file notice to feed_info Jun 24, 2022
@maximearmstrong maximearmstrong added this to In Review in The Tech Dashboard (archived) via automation Jun 27, 2022
@maximearmstrong maximearmstrong self-requested a review June 27, 2022 23:16
The Tech Dashboard (archived) automation moved this from In Review to Approved Jun 28, 2022
Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

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

Perfect, LGTM! We can merge this one when #1151 is. Thanks @KClough

@KClough KClough force-pushed the issue/877/feed_info-recommended branch from 26edb98 to 03eb4d5 Compare June 29, 2022 19:38
@maximearmstrong maximearmstrong merged commit 9824bd7 into MobilityData:master Jun 29, 2022
The Tech Dashboard (archived) automation moved this from Approved to Done Jun 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Best Practice: feed_info.txt should be provided (WARNING)
2 participants