Skip to content

Repository files navigation

magit-standup

Collect recent git commits across multiple repositories and format them as org-mode standup notes.

screenshots/standup-buffer.png

Features

  • Scans one or more git repositories for your recent commits
  • Weekday-aware lookback: on Monday (and weekends) looks back to Friday; otherwise looks back 1 day
  • Transient menu lets you override the since-date, the repository list and the author list before running
  • Filters by several authors at once, which helps when you commit under more than one identity
  • Output is an org-mode buffer with clickable commit links (via orgit or org-git-link)
  • Directories that aren’t git repos are searched recursively for nested repos

Requirements

Installation

With use-package and straight.el

(use-package magit-standup
  :straight (:host github :repo "function-artisans/magit-standup"))

Manual

Clone the repository and add it to your load-path:

(add-to-list 'load-path "/path/to/magit-standup")
(require 'magit-standup)

Usage

Run M-x magit-standup to open the transient menu:

  • -d / --since= — override the since-date (defaults to the weekday-aware computed date)
  • -r / --repos= — override the repository list
  • -a / --authors= — override the author list (comma-separated)
  • s — show the standup buffer

Press s to generate the standup notes in a *magit-standup* buffer.

Configuration

All options can be customized via M-x customize-group RET magit-standup.

VariableDefaultDescription
magit-standup-reposnilList of directories to scan. When nil, uses current repo.
magit-standup-repos-max-depth1Max depth to search non-repo directories for nested repos.
magit-standup-authorsnilList of author filters. When nil, uses git config user.email.
magit-standup-since-days-agonilFixed lookback override. When nil, weekday-aware logic.
magit-standup-link-packagenilLink style: orgit, org-git-link, none, or nil (auto-detect).

Authors

Git keeps a commit when it matches one of the entries in magit-standup-authors. Give every identity you commit under:

(setq magit-standup-authors (list "you@example.com"
                                  "you@work.example.com"))

Git applies .mailmap to the author filter. If a repository maps your commit email to another identity, give the mapped identity here. If you get no commits, compare these two commands:

git log --author=you@example.com --all
git log --format='%aN <%aE>' -1

The variable magit-standup-author (singular) still works, but it is obsolete since version 0.2.0. Use magit-standup-authors instead.

License

GPL-3.0-or-later

About

Collect recent git commits for standup notes

Topics

Resources

Stars

28 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages