Skip to content

Commit d525764

Browse files
committed
clean up the README
1 parent eca9d16 commit d525764

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed
Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
# Find Inactive Organization Members
2-
> a utility to find, and optionally remove, inactive organization members
32

4-
This utility finds users inactive since a configured date, writes those users to a file `inactive_users.csv`, and optionally removes them from the organization
3+
```
4+
find_inactive_members.rb - Find and output inactive members in an organization
5+
-c, --check Check connectivity and scope
6+
-d, --date MANDATORY Date from which to start looking for activity
7+
-e, --email Fetch the user email (can make the script take longer
8+
-o, --organization MANDATORY Organization to scan for inactive users
9+
-v, --verbose More output to STDERR
10+
-h, --help Display this help
11+
```
12+
13+
This utility finds users inactive since a configured date, writes those users to a file `inactive_users.csv`.
514

615
## Installation
716

@@ -20,27 +29,23 @@ gem install octokit
2029

2130
### Configure Octokit
2231

32+
The `OCTOKIT_ACCESS_TOKEN` is required in order to see activities on private repositories. However the `OCTOKIT_API_ENDPOINT` isn't required if connecting to GitHub.com, but is required if connecting to a GitHub Enterprise instance.
33+
2334
```shell
24-
export OCTOKIT_API_ENDPOINT="https://github.example.com/api/v3" # Default: "https://api.github.com"
25-
export OCTOKIT_ACCESS_TOKEN=00000000000000000000000
35+
export OCTOKIT_ACCESS_TOKEN=00000000000000000000000 # Required if looking for activity in private repositories.
36+
export OCTOKIT_API_ENDPOINT="https://<your_github_enterprise_instance>/api/v3" # Not required if connecting to GitHub.com.
2637
```
2738

2839
## Usage
2940

30-
```shell
31-
ruby find_inactive_members.rb -o orgName -d YYYY-MM-DD
3241
```
33-
34-
or, to automatically remove inactive members
35-
36-
```shell
37-
ruby find_inactive_members.rb -o orgName -d YYYY-MM-DD -p
42+
ruby find_active_members.rb [-cehv] -o ORGANIZATION -d DATE
3843
```
3944

4045
## How Inactivity is Defined
4146

42-
Members are defined as inactive if:
47+
Members are defined as inactive if they haven't, since the specified **DATE**, in any repository in the specified **ORGANIZATION**:
4348

44-
* They have not committed to the default branch of a repository in the org since the `YYYY-MM-DD`
45-
* They have not opened an issue or PR that has had activity since the `YYYY-MM-DD`
46-
* They have not commented on an issue or PR since the `YYYY-MM-DD`
49+
* Have not merged or pushed commits into the default branch
50+
* Have not opened an Issue or Pull Request
51+
* Have not commented on an Issue or Pull Request

0 commit comments

Comments
 (0)