https://github.com/spinnaker/rotation-scheduler
A GitHub Action for generation a rotation schedule.
https://github.com/spinnaker/rotation-scheduler
Last synced: about 1 month ago
JSON representation
A GitHub Action for generation a rotation schedule.
- Host: GitHub
- URL: https://github.com/spinnaker/rotation-scheduler
- Owner: spinnaker
- License: apache-2.0
- Created: 2020-02-25T19:33:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-16T15:46:21.000Z (about 5 years ago)
- Last Synced: 2025-04-21T01:43:44.189Z (3 months ago)
- Language: Go
- Size: 1.49 MB
- Stars: 5
- Watchers: 13
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rotation Scheduler
A GitHub Action for generating a rotation schedule.
## General Usage
Build the binary:
```bash
go build rotation.go
```
Generate a fresh schedule:
```bash
$ 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:
```bash
$ 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:
```bash
$ 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:
```bash
$ 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:
```bash
$ 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](https://support.google.com/calendar/answer/37100) 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](https://developers.google.com/admin-sdk/directory/v1/guides/delegation).
```bash
$ JSON_KEY=$(cat rotation-scheduler.json | base64 -w 0)
$ rotation calendar sync --calendarID [email protected] --jsonKey $JSON_KEY rotation-schedule.yaml
```