Skip to content

README.md

Latest commit

 

History

History
60 lines (39 loc) · 2.08 KB

README.md

File metadata and controls

60 lines (39 loc) · 2.08 KB

Find Inactive Organization Members

find_inactive_members.rb - Find and output inactive members in an organization
    -c, --check                      Check connectivity and scope
    -d, --date MANDATORY             Date from which to start looking for activity. The format is DD-MM-YYYY
    -e, --email                      Fetch the user email (can make the script take longer
    -o, --organization MANDATORY     Organization to scan for inactive users
    -v, --verbose                    More output to STDERR
    -b, --branches                   Iterate through all branches instead of only checking the default branch
    -h, --help                       Display this help

This utility finds users inactive since a configured date, writes those users to a file inactive_users.csv.

Installation

Generate a token

Generate new GitHub token with scopes repo and admin:org

Clone this repository

git clone https://github.com/github/platform-samples.git
cd api/ruby/find-inactive-members

Install dependencies

gem install octokit

Configure Octokit

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 Server instance.

export OCTOKIT_ACCESS_TOKEN=00000000000000000000000     # Required if looking for activity in private repositories.
export OCTOKIT_API_ENDPOINT="https://<your_github_enterprise_instance>/api/v3" # Not required if connecting to GitHub.com.

Usage

ruby find_inactive_members.rb [-bcehv] -o ORGANIZATION -d DATE

How Inactivity is Defined

Members are defined as inactive if they haven't, since the specified DATE, in any repository in the specified ORGANIZATION:

  • Have not merged or pushed commits into the default branch (all branches with '-b')
  • Have not opened an Issue or Pull Request
  • Have not commented on an Issue or Pull Request