Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/advanced-security/ghe-cross-instance-committers
A script which will return the total number of unique de-deuped active committers across multiple GHES instances
https://github.com/advanced-security/ghe-cross-instance-committers
ghas
Last synced: 9 days ago
JSON representation
A script which will return the total number of unique de-deuped active committers across multiple GHES instances
- Host: GitHub
- URL: https://github.com/advanced-security/ghe-cross-instance-committers
- Owner: advanced-security
- License: mit
- Created: 2023-01-27T09:21:00.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T03:42:16.000Z (7 months ago)
- Last Synced: 2024-05-01T04:35:54.622Z (7 months ago)
- Topics: ghas
- Language: TypeScript
- Homepage: https://github.com
- Size: 307 KB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Collecting GHAS Unique Active Committers
## Purpose
The purpose of this repository is to help enterprise administrators who maintain multiple GHE instances work out unique developers across multiple GHE instances. This script works for both maximum committers and currently consumed GHAS committers.
## Prerequisites
- [Node v18](https://nodejs.org/en/download/) or higher installed.
- [Git](https://git-scm.com/downloads) installed on the (user's) machine running this tool.
## Set up Instructions
1. Clone this repository onto your local machine.
```bash
git clone https://github.com/advanced-security/ghe-cross-instance-committers.git
```
2. Change the directory to the repository you have just installed.
```bash
cd ghe-cross-instance-committers
```
3. Copy the `.env.sample` to `.env`. On a Mac, this can be done via the following terminal command:
```bash
cp .env.sample .env
```
## Collecting the content
Head to the following URL in each of your GHES instances:
```
https://${ghes-url}.com/stafftools/ghas_committers
```
> **Note**
> If you are struggling to get the file to download because your instance is extremely large, please contact your account team for assistance.
If you are interested in knowing your maximum committer number (e.g. the total number of unique developers across your whole GHE instance), click the download button next to the `Total billable committers if GHAS is enabled for all repositories` option.
If you are interested in knowing your current committer number (e.g. the total number of unique developers across your whole GHE instance who are curently consuming a GHAS licence), click the download button next to the `Current active committer count` option.
Once that's downloaded, create a new folder and drop the CSV into that folder.
Repeat the steps above across all your GHES instances. Make sure you drop the content **into the same folder**, you do not need to create a new folder every time.
If you are on a GHEC instance (including EMU), please head to `https://github.com/enterprises/${enterprise-slug}/enterprise_licensing` and click "Download CSV" under the Advanced Security section. This will download a CSV, please place that in the same folder as above.
## Running the script
1. Install dependencies
```bash
npm install
```
2. Update the `.env. (Replace the XXX with the relative directory of the csv content you created above)
```bash
DIRECTORY_OF_CSV_CONTENT=XXX
```
3. Run the script
```bash
npm run start
```
The above script should output something like:
```
You have a total of XX unique developers across your GitHub instances.
```