v1

Author: Nicholas Liffen

.env.sample

@@ -0,0 +1 @@
+DIRECTORY_OF_CSV_CONTENT=__tests__/data/

.eslintrc.json

@@ -17,11 +17,5 @@
     "plugin:jest/recommended",
     "prettier"
   ],
-  "rules": {
-    // The following rule is enabled only to supplement the inline suppression
-    // examples, and because it is not a recommended rule, you should either
-    // disable it, or understand what it enforces.
-    // https://typescript-eslint.io/rules/explicit-function-return-type/
-    "@typescript-eslint/explicit-function-return-type": "warn"
-  }
+  "rules": {}
 }

.github/FUNDING.yml

@@ -11,6 +11,8 @@ coverage
 
 # Transpiled files
 build/
+lib/
+.env
 
 # VS Code
 .vscode

.gitignore

@@ -1,113 +1,72 @@
-# node-typescript-boilerplate
+# Collecting GHAS Unique Active Committers
 
-[![Sponsor][sponsor-badge]][sponsor]
-[![TypeScript version][ts-badge]][typescript-4-9]
-[![Node.js version][nodejs-badge]][nodejs]
-[![APLv2][license-badge]][license]
-[![Build Status - GitHub Actions][gha-badge]][gha-ci]
+## Purpose
 
-👩🏻‍💻 Developer Ready: A comprehensive template. Works out of the box for most [Node.js][nodejs] projects.
+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. 
 
-🏃🏽 Instant Value: All basic tools included and configured:
+## Prerequisites
 
-- [TypeScript][typescript] [4.9][typescript-4-9]
-- [ESM][esm]
-- [ESLint][eslint] with some initial rules recommendation
-- [Jest][jest] for fast unit testing and code coverage
-- Type definitions for Node.js and Jest
-- [Prettier][prettier] to enforce consistent code style
-- NPM [scripts](#available-scripts) for common operations
-- [EditorConfig][editorconfig] for consistent coding style
-- Reproducible environments thanks to [Volta][volta]
-- Example configuration for [GitHub Actions][gh-actions]
-- Simple example of TypeScript code and unit test
+- [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.
 
-🤲 Free as in speech: available under the APLv2 license.
+## Set up Instructions
 
-## Getting Started
+1.  Clone this repository onto your local machine.
 
-This project is intended to be used with the latest Active LTS release of [Node.js][nodejs].
+    ```bash
+    git clone https://github.com/advanced-security/ghes-cross-instance-committers.git
+    ```
 
-### Use as a repository template
+2.  Change the directory to the repository you have just installed.
 
-To start, just click the **[Use template][repo-template-action]** link (or the green button). Start adding your code in the `src` and unit tests in the `__tests__` directories.
+    ```bash
+    cd ghes-cross-instance-committers
+    ```
 
-### Clone repository
+4.  Copy the `.env.sample` to `.env`. On a Mac, this can be done via the following terminal command:
 
-To clone the repository, use the following commands:
+    ```bash
+    cp .env.sample .env
+    ```
 
-```sh
-git clone https://github.com/jsynowiec/node-typescript-boilerplate
-cd node-typescript-boilerplate
-npm install
-```
-
-### Download latest release
+## Collecting the content
 
-Download and unzip the current **main** branch or one of the tags:
+Head to the following URL in each of your GHES instances:
 
-```sh
-wget https://github.com/jsynowiec/node-typescript-boilerplate/archive/main.zip -O node-typescript-boilerplate.zip
-unzip node-typescript-boilerplate.zip && rm node-typescript-boilerplate.zip
+```
+https://${ghes-url}.com/stafftools/ghas_committers
 ```
 
-## Available Scripts
-
-- `clean` - remove coverage data, Jest cache and transpiled files,
-- `prebuild` - lint source files and tests before building,
-- `build` - transpile TypeScript to ES6,
-- `build:watch` - interactive watch mode to automatically transpile source files,
-- `lint` - lint source files and tests,
-- `prettier` - reformat files,
-- `test` - run tests,
-- `test:watch` - interactive watch mode to automatically re-run tests
-
-## Additional Information
+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. 
 
-### Why include Volta
+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.
 
-[Volta][volta]’s toolchain always keeps track of where you are, it makes sure the tools you use always respect the settings of the project you’re working on. This means you don’t have to worry about changing the state of your installed software when switching between projects. For example, it's [used by engineers at LinkedIn][volta-tomdale] to standardize tools and have reproducible development environments.
+Once that's downloaded, create a new folder and drop the CSV into that folder. 
 
-I recommend to [install][volta-getting-started] Volta and use it to manage your project's toolchain.
+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. 
 
-### ES Modules
+## Running the script
 
-This template uses native [ESM][esm]. Make sure to read [this][nodejs-esm], and [this][ts47-esm] first.
+1.  Install dependencies
 
-If your project requires CommonJS, you will have to [convert to ESM][sindresorhus-esm].
+    ```bash
+    npm install
+    ```
 
-Please do not open issues for questions regarding CommonJS or ESM on this repo.
+3.  Update the `.env. (Replace the XXX with the relative directory of the csv content you created above)
 
-## Backers & Sponsors
+    ```bash
+    DIRECTORY_OF_CSV_CONTENT=XXX
+    ```
 
-Support this project by becoming a [sponsor][sponsor].
+2.  Run the script
 
-## License
+    ```bash
+    npm run start
+    ```
 
-Licensed under the APLv2. See the [LICENSE](https://github.com/jsynowiec/node-typescript-boilerplate/blob/main/LICENSE) file for details.
+The above script should output something like:
 
-[ts-badge]: https://img.shields.io/badge/TypeScript-4.9-blue.svg
-[nodejs-badge]: https://img.shields.io/badge/Node.js->=%2018.12-blue.svg
-[nodejs]: https://nodejs.org/dist/latest-v18.x/docs/api/
-[gha-badge]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml/badge.svg
-[gha-ci]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml
-[typescript]: https://www.typescriptlang.org/
-[typescript-4-9]: https://devblogs.microsoft.com/typescript/announcing-typescript-4-9/
-[license-badge]: https://img.shields.io/badge/license-APLv2-blue.svg
-[license]: https://github.com/jsynowiec/node-typescript-boilerplate/blob/main/LICENSE
-[sponsor-badge]: https://img.shields.io/badge/♥-Sponsor-fc0fb5.svg
-[sponsor]: https://github.com/sponsors/jsynowiec
-[jest]: https://facebook.github.io/jest/
-[eslint]: https://github.com/eslint/eslint
-[wiki-js-tests]: https://github.com/jsynowiec/node-typescript-boilerplate/wiki/Unit-tests-in-plain-JavaScript
-[prettier]: https://prettier.io
-[volta]: https://volta.sh
-[volta-getting-started]: https://docs.volta.sh/guide/getting-started
-[volta-tomdale]: https://twitter.com/tomdale/status/1162017336699838467?s=20
-[gh-actions]: https://github.com/features/actions
-[repo-template-action]: https://github.com/jsynowiec/node-typescript-boilerplate/generate
-[esm]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
-[sindresorhus-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
-[nodejs-esm]: https://nodejs.org/docs/latest-v16.x/api/esm.html
-[ts47-esm]: https://devblogs.microsoft.com/typescript/announcing-typescript-4-9/#esm-nodejs
-[editorconfig]: https://editorconfig.org
+```
+You have a total of XX unique developers across your GitHub instances.
+```

README.md

@@ -0,0 +1,28 @@
+User login,Organization / repository,Last pushed date
+user1,org/repo,2023-01-27
+user1,org1/repo2,2022-11-28
+user1,org1/repo2,2022-11-28
+user2,org1/repo2,2022-11-28
+user2,org1/repo2,2022-11-28
+user2,org1/repo2,2022-11-28
+user2,org1/repo3,2023-01-10
+user3,org1/repo2,2022-11-28
+user3,org1/repo2,2022-11-28
+user3,org1/repo2,2022-11-28
+user3,org1/repo2,2022-11-28
+user4,org3/repo1,2022-12-16
+user4,org5/repo8,2023-01-25
+user4,org1/repo2,2022-11-28
+user4,org4/repo6,2022-12-02
+user4,org8/repo1,2022-12-02
+user5,org6/repo2,2023-01-04
+user5,org1/repo2,2022-12-01
+user5,org2/repo3,2023-01-06
+user5,org4/repo9,2023-01-06
+user5,org10/repo4,2023-01-06
+user6,org1/repo2,2022-11-28
+user6,org1/repo2,2022-11-28
+user6,org1/repo2,2022-11-28
+user6,org9/repo3,2023-01-18
+user7,org9/repo3,2023-01-08
+user7,org10/repo1,2023-01-10

__tests__/data/ghas_active_committers_github_2023-01-27T0917.csv

@@ -0,0 +1,29 @@
+User login,Organization / repository,Last pushed date
+user1,org/repo,2023-01-27
+user1,org1/repo2,2022-11-28
+user1,org1/repo2,2022-11-28
+user2,org1/repo2,2022-11-28
+user2,org1/repo2,2022-11-28
+user2,org1/repo2,2022-11-28
+user2,org1/repo3,2023-01-10
+user1,org1/repo2,2022-11-28
+user3,org1/repo2,2022-11-28
+user3,org1/repo2,2022-11-28
+user1,org1/repo2,2022-11-28
+user4,org3/repo1,2022-12-16
+user1,org5/repo8,2023-01-25
+user4,org1/repo2,2022-11-28
+user4,org4/repo6,2022-12-02
+user4,org8/repo1,2022-12-02
+user5,org6/repo2,2023-01-04
+user5,org1/repo2,2022-12-01
+user9,org2/repo3,2023-01-06
+user5,org4/repo9,2023-01-06
+user5,org10/repo4,2023-01-06
+user6,org1/repo2,2022-11-28
+user2,org1/repo2,2022-11-28
+user6,org1/repo2,2022-11-28
+user6,org9/repo3,2023-01-18
+user12,org9/repo3,2023-01-08
+user7,org10/repo1,2023-01-10
+user8,org10/repo1,2023-01-10