|
| 1 | +#+title: magit-standup |
| 2 | +#+author: István Karaszi |
| 3 | + |
| 4 | +Collect recent git commits across multiple repositories and format them as org-mode standup notes. |
| 5 | + |
| 6 | +[[file:screenshots/standup-buffer.png]] |
| 7 | + |
| 8 | +* Features |
| 9 | + |
| 10 | +- Scans one or more git repositories for your recent commits |
| 11 | +- Weekday-aware lookback: on Monday (and weekends) looks back to Friday; otherwise looks back 1 day |
| 12 | +- Transient menu lets you override the since-date and repository list before running |
| 13 | +- Output is an org-mode buffer with clickable commit links (via [[https://github.com/magit/orgit][orgit]] or [[https://orgmode.org/worg/org-contrib/org-git-link.html][org-git-link]]) |
| 14 | +- Directories that aren't git repos are searched recursively for nested repos |
| 15 | + |
| 16 | +* Requirements |
| 17 | + |
| 18 | +- Emacs 28.1+ |
| 19 | +- [[https://github.com/magit/magit][Magit]] 4.5.0+ |
| 20 | +- [[https://github.com/magit/transient][Transient]] 0.8.0+ |
| 21 | + |
| 22 | +* Installation |
| 23 | + |
| 24 | +** With use-package and straight.el |
| 25 | + |
| 26 | +#+begin_src emacs-lisp |
| 27 | +(use-package magit-standup |
| 28 | + :straight (:host github :repo "function-artisans/magit-standup")) |
| 29 | +#+end_src |
| 30 | + |
| 31 | +** Manual |
| 32 | + |
| 33 | +Clone the repository and add it to your =load-path=: |
| 34 | + |
| 35 | +#+begin_src emacs-lisp |
| 36 | +(add-to-list 'load-path "/path/to/magit-standup") |
| 37 | +(require 'magit-standup) |
| 38 | +#+end_src |
| 39 | + |
| 40 | +* Usage |
| 41 | + |
| 42 | +Run =M-x magit-standup= to open the transient menu: |
| 43 | + |
| 44 | +- =-d= / =--since== — override the since-date (defaults to the weekday-aware computed date) |
| 45 | +- =-r= / =--repos== — override the repository list |
| 46 | +- =s= — show the standup buffer |
| 47 | + |
| 48 | +Press =s= to generate the standup notes in a =*magit-standup*= buffer. |
| 49 | + |
| 50 | +* Configuration |
| 51 | + |
| 52 | +All options can be customized via =M-x customize-group RET magit-standup=. |
| 53 | + |
| 54 | +| Variable | Default | Description | |
| 55 | +|---------------------------------+---------+--------------------------------------------------------------------| |
| 56 | +| =magit-standup-repos= | =nil= | List of directories to scan. When nil, uses current repo. | |
| 57 | +| =magit-standup-repos-max-depth= | =1= | Max depth to search non-repo directories for nested repos. | |
| 58 | +| =magit-standup-author= | =nil= | Author filter. When nil, uses =git config user.email=. | |
| 59 | +| =magit-standup-since-days-ago= | =nil= | Fixed lookback override. When nil, weekday-aware logic. | |
| 60 | +| =magit-standup-link-package= | =nil= | Link style: =orgit=, =org-git-link=, =none=, or nil (auto-detect). | |
| 61 | + |
| 62 | +* License |
| 63 | + |
| 64 | +GPL-3.0-or-later |
0 commit comments