notify owner if about.yaml fails to parse (via CI)

[ultrasaurus]

related to: https://github.com/18F/dashboard/issues/264

[ultrasaurus]

was: send email better to comment on the PR so someone can fix before the broken thing shows up on the dashboard

[DavidEBest]

It looks like this could be done by extending the pshb.js webhook a bit.

We'd need to:

• Expose the about_yml validate script (might be easier said than done)
• Create a validation path that is called when there is a push to a non-default_branch branch.
• If the push updated or added an .about.yml:
  • That validation path should validate the yaml
  • Use the Github Status API to alert the user to the success/failure of the validation.

A few things I'm not sure about yet:

• I think the Github Status API will require a user with push access to the repo, is that something that the hook that handles the team api redeploys can do?
• Github Status API expects that we will provide a link where a user can see the errors for their build - if we follow that convention, then we'd need to have someplace to put those validation logs. (Redeploy the team api with updated error info?)
• The about_yml validation doesn't catch cross-ref errors (unknown team members), that is done in the team_api.

Thoughts?

[mbland]

psjb.js has been renamed to project-data-updater.js in the team-api-server npm. Just haven't gotten around to ripping out the old version from 18F/team-api.

about_yml_validate is part of the about_yml gem.

We actually shouldn't care about any branch but the default.

Will have to read up on the GH Status API later.

I'm thinking we can add some kind of a hook whereby the about_yml_validate tool can either import team member data for validation, or send its updates to an API endpoint to perform the validation.

[mbland]

cc: @mtorres253 We'll need to add a story to create a CI service for .about.yml validation (think "Travis for .about.yml").

[mtorres253]

Created a in the team API project: https://waffle.io/18F/team_api/cards/56422991a2cfa30f0099399c

[mbland]

Also addressed by 18F/about_yml#37.

[mbland]

Update in 18F/about_yml#37.

Still need to document how to integrate the MVP mechanism into one's Travis build.