workflow summary

Say what you did over a period — commits, tasks, issues and reviews — and post it

Synopsis

Read back what you did, as the Summary pane and the web’s Summary section read it: the commits you wrote, the Taskwarrior tasks you touched, what you did to Jira issues, and the pull or merge requests you opened, had merged and reviewed. It prints the summary as Markdown, by year, month, day and hour; –json prints the web API’s Activity shape instead. –from and –to name the first and last day, written YYYY-MM-DD; one alone is that day, and neither is the previous working day.

–post previews it and posts it to the configured Slack, Teams, Discord or webhook once you confirm, its headings written as the service shows them; with a Slack user token, –channel posts it in another channel than messaging.channel. Nothing is kept: each run reads the sources again. A source that cannot be read is named in the summary, and the command exits non-zero once it has printed the rest. A source that is not set up — no token, no forge the base remote names, no Taskwarrior — is left out, with a note on standard error saying how to set it up.

workflow summary [flags]

Examples

  workflow summary --json | jq -r .text   # what you did on the previous working day
  workflow summary --post --yes          # post it to your team, unattended

Options

      --channel CHANNEL   with --post, post in CHANNEL instead of messaging.channel; a Slack user token only
      --from string       the first day, written YYYY-MM-DD
  -h, --help              help for summary
  -j, --json              print the summary as JSON
      --post              post the summary to your team's chat, after a preview
      --to string         the last day, written YYYY-MM-DD
  -y, --yes               post without the confirmation

Options inherited from parent commands

  -n, --dry-run             hold back every write to Jira, the forge, the messaging service, Taskwarrior, git and files, and say what it would have done
      --log-format FORMAT   say what goes to stderr as FORMAT: text, or json or logfmt, an entry a line stamped with its time (default text)
  -q, --quiet               say only warnings, errors and questions on stderr, leaving every note out
      --request-log FILE    append a one-line outline of each request (method, path, status, duration) to FILE, for a bug report
      --verbose             also say each request's outline on stderr, as a debug line (not while the terminal interface draws)