Skip to content

Jdweiner526 docfix 1 #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 28, 2020
Merged

Jdweiner526 docfix 1 #321

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
254f33a
Update README.md
jdweiner526 Apr 9, 2020
75f9fe4
Update README.md
jdweiner526 Apr 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions api/ruby/find-inactive-members/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
```
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
-e, --email Fetch the user email (can make the script take longer
-d, --date MANDATORY Date from which to start looking for activity (in a format parseable by the Ruby Date class: https://ruby-doc.org/stdlib/libdoc/date/rdoc/Date.html)
-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
-h, --help Display this help
```

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

## Installation

Expand Down Expand Up @@ -42,6 +42,11 @@ export OCTOKIT_API_ENDPOINT="https://<your_github_enterprise_instance>/api/v3" #
ruby find_inactive_members.rb [-cehv] -o ORGANIZATION -d DATE
```

## Examples
```
ruby find_inactive_members.rb -o YoyodynePropulsionSystems -d "Feb 10 2020"
```

## How Inactivity is Defined

Members are defined as inactive if they **have not performed** any of the following actions in any repository in the specified **ORGANIZATION** since the specified **DATE**:
Expand Down