eclipse-pass / main

Catch all repository against which issues of general, cross cutting topics are logged.
Apache License 2.0
4 stars 8 forks source link

Document process to remove sensitive/secret data from commits in github #996

Open rpoet-jh opened 5 months ago

rpoet-jh commented 5 months ago

What?

We need to create a document describing how to remove sensitive/secret data from commits accidentally pushed to a PASS repository in PASS.

Why?

We need a documented process because it is not straightforward to remove commits from github. Additionally, devs are not admins of the PASS repos, Eclipse Foundation is, this adds complexity.

How?

Here is documentation in github as a starting point: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository

We should look at all the repos and evaluate integration such as pass-documentation -> gitbook and incorporate docs for that too.

Acceptance Criteria

A document describing how to remove sensitive/secret data from PASS repositories.

rpoet-jh commented 5 months ago

For the step where one needs to have github run gc and clear cached views (which will be required), here is how it can be done:

I opened a github support ticket to run gc and clear cache views on the repo. They completed it, and the commits were gone in github. They completed the ticket in about 1.5 hours.

My impression that I had to be admin was given by the copilot agent that comes up first when you open the page to create the ticket. However, you can close that and just open the ticket. So that requirement isn't really one for this type of request.