From 63952e35a97749c75e5589808286318cc1bc9287 Mon Sep 17 00:00:00 2001 From: stvnrlly Date: Fri, 17 Nov 2023 09:47:32 -0500 Subject: [PATCH] freshen up files --- .github/dependabot.yml | 1 - .github/workflows/adr-accepted.yml | 2 -- CONTRIBUTING.md | 2 +- LICENSE.md | 2 +- docs/adrs/0002-how-to-handle-timezones.md | 2 +- ...0004-designing-pilot-content-visibility.md | 2 -- ...nage-total-record-retention-dynamically.md | 2 +- ...e-paid-quotas-at-the-organization-level.md | 4 ++-- docs/all.md | 19 ++++++++++++++----- docs/localstack.md | 4 ++-- migrations/alembic.ini | 2 +- .../versions/0025_notify_service_data.py | 4 ++-- .../0095_migrate_existing_svc_perms.py | 14 +++++++------- .../0139_migrate_sms_allowance_data.py | 8 ++++---- .../versions/0156_set_temp_letter_contact.py | 2 +- .../versions/0171_add_org_invite_template.py | 4 ++-- migrations/versions/0191_ft_billing_pkey.py | 8 ++++---- .../0265_add_confirm_edit_templates.py | 4 ++-- .../versions/0285_default_org_branding.py | 4 ++-- .../versions/0294_add_verify_reply_to_.py | 6 +++--- .../versions/0298_add_mou_signed_receipt.py | 6 +++--- .../versions/0303_populate_services_org_id.py | 2 +- .../0312_populate_returned_letters.py | 4 ++-- .../versions/0320_optimise_notifications.py | 4 ++-- .../versions/0327_idx_notification_history.py | 14 +++++++------- .../0347_add_dvla_volumes_template.py | 6 +++--- .../0351_unique_key_annual_billing.py | 2 +- migrations/versions/0378_add_org_names.py | 4 ++-- test_csv_files/multiple_letter.csv | 2 +- 29 files changed, 72 insertions(+), 68 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 2cbc35964..ba1c6b80a 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,4 +9,3 @@ updates: directory: "/" # Location of package manifests schedule: interval: "daily" - diff --git a/.github/workflows/adr-accepted.yml b/.github/workflows/adr-accepted.yml index e57699be7..bcc3672d5 100644 --- a/.github/workflows/adr-accepted.yml +++ b/.github/workflows/adr-accepted.yml @@ -81,5 +81,3 @@ jobs: --title "Add ADR ${{ steps.next.outputs.number }} to the repo" \ --body "This pull request was opened automatically because #${{ github.event.issue.number }} was closed after being marked as an approved ADR. It contains a markdown file capturing the ADR body at the time the issue was closed. Please verify that the markdown is correct before merging!" || true gh pr merge $BRANCH --auto --squash || true - - \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2792b81f..ded01806d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,4 +16,4 @@ As part of a U.S. government agency, the General Services Administration (GSA) This project is in the public domain within the United States, and applicable copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/). -All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest. \ No newline at end of file +All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest. diff --git a/LICENSE.md b/LICENSE.md index 97bd78bc0..35c96d354 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -50,4 +50,4 @@ As stated in [CONTRIBUTING](CONTRIBUTING.md), all contributions to this project ## Trademark -GSA owns, reserves, and retains all rights, title, and interest in all trademarks owned by GSA. The User does not acquire any right or interest of any kind in any GSA trademark because of their use of the Modified Version or any of the modifications made to the Work by GSA. \ No newline at end of file +GSA owns, reserves, and retains all rights, title, and interest in all trademarks owned by GSA. The User does not acquire any right or interest of any kind in any GSA trademark because of their use of the Modified Version or any of the modifications made to the Work by GSA. diff --git a/docs/adrs/0002-how-to-handle-timezones.md b/docs/adrs/0002-how-to-handle-timezones.md index 2a0df5954..986edf568 100644 --- a/docs/adrs/0002-how-to-handle-timezones.md +++ b/docs/adrs/0002-how-to-handle-timezones.md @@ -31,7 +31,7 @@ We've also identified the following areas as pieces of the application and service that could be impacted by any timezone changes: - Reports by day (or specific month/year) -- Jobs running at a reasonable time +- Jobs running at a reasonable time - Job schedules (we want users to understand when things will happen) - Scheduling sending of messages - UI listing of time messages were sent diff --git a/docs/adrs/0004-designing-pilot-content-visibility.md b/docs/adrs/0004-designing-pilot-content-visibility.md index 427258e12..17c34118c 100644 --- a/docs/adrs/0004-designing-pilot-content-visibility.md +++ b/docs/adrs/0004-designing-pilot-content-visibility.md @@ -79,5 +79,3 @@ Mockup of Option 1: Mockup of Option 2: ![Option 2](https://github.com/GSA/notifications-api/assets/6556888/ea7442e4-745a-49d2-a90c-156cc6129356) - - diff --git a/docs/adrs/0007-adr-manage-total-record-retention-dynamically.md b/docs/adrs/0007-adr-manage-total-record-retention-dynamically.md index f0c654974..9b1cc7217 100644 --- a/docs/adrs/0007-adr-manage-total-record-retention-dynamically.md +++ b/docs/adrs/0007-adr-manage-total-record-retention-dynamically.md @@ -36,4 +36,4 @@ _No response_ ### Next Steps -#463 \ No newline at end of file +#463 diff --git a/docs/adrs/0008-adr-handle-paid-quotas-at-the-organization-level.md b/docs/adrs/0008-adr-handle-paid-quotas-at-the-organization-level.md index c502ededb..91367f84b 100644 --- a/docs/adrs/0008-adr-handle-paid-quotas-at-the-organization-level.md +++ b/docs/adrs/0008-adr-handle-paid-quotas-at-the-organization-level.md @@ -27,11 +27,11 @@ At this time, services will pull directly from the organization's quota. We may ### Author -@stvnrlly, @ccostino, @tdlowden +@stvnrlly, @ccostino, @tdlowden ### Stakeholders -@amyashida +@amyashida ### Next Steps diff --git a/docs/all.md b/docs/all.md index 28dea614a..3334e0a45 100644 --- a/docs/all.md +++ b/docs/all.md @@ -6,6 +6,7 @@ - [Onboarding](#onboarding) - [Setting up the infrastructure](#setting-up-the-infrastructure) - [Using the logs](#using-the-logs) +- [`git` hooks](#git-hooks) - [Testing](#testing) - [CI testing](#ci-testing) - [Manual testing](#manual-testing) @@ -231,6 +232,14 @@ Staging: https://logs.fr.cloud.gov/app/discover#/view/73d7c820-596e-11ee-a43a-09 Once in the view, you'll likely want to adjust the time range in the upper right of the page. +# `git` hooks + +We're using [`pre-commit`](https://pre-commit.com/) to manage hooks in order to automate common tasks or easily-missed cleanup. It's installed as part of `make bootstrap` and is limited to this project's virtualenv. + +The configuration is stored in `.pre-commit-config.yaml`. In that config, there are links to the repos from which the hooks are pulled, so hop through there if you want a detailed description of what each one is doing. + +We do not maintain any hooks in this repository. + # Testing ``` @@ -428,7 +437,7 @@ There is a Flask command to wipe user-created data (users, services, etc.). The command should stop itself if it's run in a production environment, but, you know, please don't run it in a production environment. -Running locally: +Running locally: ``` flask command purge_functional_test_data -u @@ -445,7 +454,7 @@ cf run-task notify-api "flask command purge_functional_test_data -u