Rotation Scheduler

A GitHub Action for generating a rotation schedule.

General Usage

Build the binary:

go build rotation.go

Generate a fresh schedule:

$ rotation schedule generate --start 2020-03-01 --stop 2020-04-01 --users abc,lmn,xyz
shifts:
- startDate: Sun 01 Mar 2020
  user: abc
- startDate: Sun 08 Mar 2020
  user: lmn
- startDate: Sun 15 Mar 2020
  user: xyz
- startDate: Sun 22 Mar 2020
  stopDate: Sat 28 Mar 2020
  user: abc

Write the schedule to a file automatically:

$ rotation schedule generate --start 2020-03-01 --stop 2020-04-01 --users abc,lmn,xyz rotation-schedule.yaml

Periodically extend the schedule, optionally changing the users:

$ rotation schedule extend --schedule rotation-schedule.yaml --stop 2020-05-01 --users abc,lmn,xyz,123 rotation-schedule.yaml
$ cat rotation-schedule.yaml
shifts:
- startDate: Sun 01 Mar 2020
  user: abc
- startDate: Sun 08 Mar 2020
  user: lmn
- startDate: Sun 15 Mar 2020
  user: xyz
- startDate: Sun 22 Mar 2020
  user: abc
- startDate: Sun 29 Mar 2020
  user: lmn
- startDate: Sun 05 Apr 2020
  user: xyz
- startDate: Sun 12 Apr 2020
  user: "123"
- startDate: Sun 19 Apr 2020
  stopDate: Sat 25 Apr 2020
  user: abc

Use --prune flag to remove past shifts and reschedule shifts when users drop out of rotation:

$ date '+%Y-%m-%d' # pruning works from the current date. Only whole shifts are removed.
2020-04-09

$ rotation schedule extend --prune --schedule rotation-schedule.yaml --stop 2020-05-01 --users lmn,xyz,123 rotation-schedule.yaml
$ cat rotation-schedule.yaml
shifts:
- startDate: Sun 05 Apr 2020
  user: xyz
- startDate: Sun 12 Apr 2020
  user: "123"
- startDate: Sun 19 Apr 2020
  stopDate: Sat 25 Apr 2020
  user: lmn

Includes GitHub Teams integration:

$ rotation schedule generate --start 2020-03-01 --stop 2020-04-01 --github spinnaker,build-cops,$GITHUB_TOKEN
shifts:
- startDate: Sun 01 Mar 2020
  user: ajordens
- startDate: Sun 08 Mar 2020
  user: cfieber
- startDate: Sun 15 Mar 2020
  user: ethanfrogers
- startDate: Sun 22 Mar 2020
  stopDate: Sat 28 Mar 2020
  user: ezimanyi

Sync schedule to Google Calendar.

Google Calendar integration works by specifying a dedicated. non-human user (specified with --calendarID) to own all the Calendar events in the schedule. Each rotation user can then add that user's calendar to their own to see all of the current shifts.

NOTE: This dedicated user is strongly recommended, because during each sync, all events on that calendar are deleted before the new shifts are added. You wouldn't want your personal calendar to be cleared accidentally.

Optionally, each user (or userOverride) field can be an email address, in which case that email would be invited as an attendee to that Calendar event.

The --jsonKey is a Google Cloud Platform service account with domain-wide delegation.

$ JSON_KEY=$(cat rotation-scheduler.json | base64 -w 0)
$ rotation calendar sync --calendarID build-cop@spinnaker.io --jsonKey $JSON_KEY rotation-schedule.yaml