https://github.com/inigomarquinez/github-snitch
🕵️ GitHub action that retrieves the basic information of all repos of a github user/organisation.
https://github.com/inigomarquinez/github-snitch
github github-action iac
Last synced: about 1 month ago
JSON representation
🕵️ GitHub action that retrieves the basic information of all repos of a github user/organisation.
- Host: GitHub
- URL: https://github.com/inigomarquinez/github-snitch
- Owner: inigomarquinez
- License: mit
- Created: 2023-02-23T18:50:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-20T21:37:47.000Z (about 1 year ago)
- Last Synced: 2024-10-06T14:41:20.621Z (7 months ago)
- Topics: github, github-action, iac
- Language: TypeScript
- Homepage:
- Size: 325 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub snitch
This tools analyses the configuration of the GitHub repositories of your *organization* and creates a report with the risks for every repository.
⚠️ Right now it only works with GitHub organizations, not for individual accounts.
## How to run it
1. Clone this repository
2. In the root of the project create an `.env` file with the following values:
```bash
GITHUB_ORG_NAME=
GITHUB_PAT=
```
You can also copy-paste and rename the example `.env.template` file.
If you don't kwow how to create a Personal Access Token for your organization, follow [these instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). The Personal Access Toekn you create needs to have `repo` and `admin:org > read:org` access.
### 🚨 Github rate limiting
Be careful when using this tool, because GitHub has a [rate limiting](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting).