GSA / data.gov

Main repository for the data.gov service
https://data.gov
Other
600 stars 95 forks source link

Open an issue on datagov-deploy when broken links are identified on static sites #2922

Closed adborden closed 5 months ago

adborden commented 3 years ago

User Story

In order to promptly notify and nudge the team to take action when broken links are identified, data.gov team wants static sites to open a GH issue in datagov-deploy when a qa check fails.

Acceptance Criteria

[ACs should be clearly demoable/verifiable whenever possible. Try specifying them using BDD.]

Background

Some of our sites (resources.data.gov) have a qa task that checks for broken links. This is run ~weekly in CI, but its easy to miss. Only those following the CircleCI project will receive an email. If we open an issue in datagov-deploy, we'll make sure to triage it as it is discovered and can even get a weekly reminder on it.

Security Considerations (required)

[Any security concerns that might be implicated in the change. "None" is OK, just be explicit here!]

Sketch

mogul commented 3 years ago

In the meantime, we can add checking the QA task output to the O&M role.

nickumia-reisys commented 1 year ago

Seeing as how the broken link checking algorithm is flaky, this is not a priority as the false positive rate would be too high. The following issue is related:

We may pick this up in the future? We have the infrastructure to enable this since we create issues when catalog/inventory restarts/deployments fail,

Since the QA Job is a Github Action, the same design could be implemented here.

hkdctol commented 11 months ago

Might be taken care of by #4476 so icebox for now, might be closed if we finish that other one