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

Remove .secrets.baseline #169

Merged
merged 1 commit into from
Feb 5, 2024
Merged

Remove .secrets.baseline #169

merged 1 commit into from
Feb 5, 2024

Conversation

huwd
Copy link
Contributor

@huwd huwd commented Jan 31, 2024

Closes: #162

This file was generated as part of the initial commit and hasn't been touched since.

It's a config file for detect-secrets which is a pre-commit hook scanning tool looking for stuff that looks a bit like secrets and catching them before you commit and send them to github repos.

Two reasons we're removing this:

  1. Detect Secrets and Pre-commit hooks do not appear to be widely used by this team, nor integrated into our documentation. If we think there's value in this approach we should look at bringing it back alongside a wider bit of team training, and with a view to our README.md and onboarding.

  2. We can effectively deem this repository as a low risk for secrets leakage, whilst it does have a deployment element and there is always a risk there, most of the changes are content related. Those with access to keys that could be leaked are small in number. Were we to spot any leakage, it's those same folks who could quickly rotate keys. And this is not an application that contains PII. Worst case we can blow it away and redeploy as a static site.

That's not to preclude us looking at a better security threat assessment here, just to say that for now it's not a burning priority here and if we change our mind we should bring it back as part of a fuller implimentation.

Technical writer support

More tooling for around the repo

How to review

Check you understand what's been removed, why, and that you agree.

This file was generated as part of the initial commit and hasn't been
touched since.

It's a config file for [detect-secrets][1] which is a pre-commit hook
scanning tool looking for stuff that looks a bit like secrets and
catching them before you commit and send them to github repos.

Two reasons we're removing this:

1. Detect Secrets and Pre-commit hooks do not appear to be widely used
   by this team, nor integrated into our documentation. If we think
   there's value in this approach we should look at bringing it back
   alongside a wider bit of team training, and with a view to our
   README.md and onboarding.

2. We can effectively deem this repository as a low risk for secrets
   leakage, whilst it does have a deployment element and there is always
   a risk there, most of the changes are content related. Those with
   access to keys that could be leaked are small in number. Were we to
   spot any leakage, it's those same folks who could quickly rotate
   keys. And this is not an application that contains PII. Worst case we
   can blow it away and redeploy as a static site.

That's not to preclude us looking at a better security threat assessment
here, just to say that for now it's not a burning priority here and if
we change our mind we should bring it back as part of a fuller
implimentation.

[1]: https://github.com/Yelp/detect-secrets
@huwd huwd requested a review from a team January 31, 2024 14:58
@huwd huwd requested review from a team as code owners January 31, 2024 14:58
@huwd huwd requested review from a team and pauldougan January 31, 2024 14:58
Copy link
Contributor

@andyloughran andyloughran left a comment

Choose a reason for hiding this comment

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

Agree with your justification. Legacy stuff should be deleted if not used.

@huwd huwd merged commit 5aebf9f into main Feb 5, 2024
1 check passed
@huwd huwd deleted the remove-secrets-baseline branch February 5, 2024 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove redundant .secrets.baseline file
2 participants