Skip to content

Latest commit

 

History

History
108 lines (80 loc) · 2.48 KB

README.md

File metadata and controls

108 lines (80 loc) · 2.48 KB
Raw

okra

Aggregation tool for markdown-based activity reports.

Build Status

okra can:

  • Generate a weekly report stub with your Github activity
  • Lint reports to check they are in the expected format
  • Aggregate weekly reports for multiple engineers and projects

Getting Started

Installation

Install opam if you don't already have it, and add tarides/opam-repository to your list of opam repositories:

Either only to the current opam switch with the command:

opam repository add tarides https://github.com/tarides/opam-repository.git

Or to the list of opam repositories for all opam switches with the command:

opam repository add --all tarides https://github.com/tarides/opam-repository.git

Update your list of packages:

opam update

Then you can install okra. If you had it installed previously through pinning simply run:

opam pin remove okra

This will both remove the pinned version and install the new one. You may also need to opam pin remove okra-lib too.

If okra is not installed yet, run:

opam install okra

Usage

For engineers

To generate your last week report:

okra gen

To update your report by rewriting workitems into objectives:

okra cat -C /path/to/admin -e old_weekly.md -o new_weekly.md

To lint your report:

okra lint -e -C /path/to/admin/ report.md

For more details, please refer to the Engineer's Manual.

For team leads

To aggregate engineer reports:

cat magnus.md patrick.md | okra cat --engineer

To lint engineer reports of your team:

okra team lint -C /path/to/admin/ -w 40-41

To aggregate team reports:

cat team1.md team2.md | okra cat --team

To lint a team report:

okra lint -t -C /path/to/admin/ report.md

For more details, please refer to the Team Lead's Manual.

Documentation

The full documentation for okra can be found here.