This changeset adds a new ADR, 0015 (Improve API stability when processing job data and generating reports), and updates the ADR log in the ADR README.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset formalizes the new ADR (Architectural Decision Record) that proposed localizing the notifications-python-client into the API and Admin applications.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset adds documentation to help our team manage our secrets detection with the detect-secrets pre-commit plugin.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset adds a bunch of new information on how to manage environment variables and credentials in our application.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset adds a new runbook to our documentation that explains how to review our daily scans for new findings.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset updates our runbook for the DNS and domain management:
* Add instructions and steps for how to perform the necessary actions to add and/or remove domains
* Update links to existing resources
* Add links to additional documentation
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset makes a few adjustments to our sandbox environment config to make the sandbox deployments of the API much easier. It does this with the following:
* Adds a few environment variable values to the sandbox.yml file to cover the ones that were not there previously
* Adds a new script that can be run in place of memorizing any commands
* Adds documentation on how to configure and run the sandbox environment
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset adds the steps to take for setting up a new production deployment. This includes instructions on creating the release notes and what to do once the deploys are done (and if they fail, what to do to help troubleshoot).
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset updates ADR 0009 - BackstopJS integration - to be accepted now that it has undergone some review.
It also adds a few extra details about what the next steps will look like with firmer language that we will be integrating this as a new job in our CI/CD process.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset updates our pull request template to be much more streamlined and shifts most of the information to our documentation. The PR template now links to the docs for folks who are new and unfamiliar with what we require in our pull requests so that the template itself just has the headings and quick outlines to get started more easily and quickly.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
Apparently this error is common:
```
FATAL: database "test_notification_api" does not exist
```
In lieu of getting to the bottom of it, add a note about how to fix it
