No description
d29c5c0df6
When pulling stories from clubhouse by any method (either headline-from-story or headlines-from-query) also pull down the list of tasks on the story as children of the headline. Fixes #15 |
||
---|---|---|
LICENSE | ||
org-clubhouse.el | ||
README.org |
Org-Clubhouse
Simple, unopinionated integration between Emacs's org-mode and the Clubhouse issue tracker
Install
Quelpa
(quelpa '(org-clubhouse
:fetcher github
:repo "urbint/org-clubhouse"))
DOOM Emacs
;; in packages.el
(package! org-clubhouse
:recipe (:fetcher github
:repo "urbint/org-clubhouse"
:files ("*")))
;; in config.el
(def-package! org-clubhouse)
Spacemacs
;; in .spacemacs (SPC+fed)
dotspacemacs-additional-packages
'((org-clubhouse :location (recipe :fetcher github :repo "urbint/org-clubhouse")))
Setup
Once installed, you'll need to set three global config vars:
(setq org-clubhouse-auth-token "<your-token>"
org-clubhouse-team-name "<your-team-name>"
org-clubhouse-username "<your-username>")
You can generate a new personal API token by going to the "API Tokens" tab on the "Settings" page in the clubhouse UI.
Org-clubhouse can be configured to update the status of stories as you update
their todo-keyword in org-mode. To opt-into this behavior, set the
org-clubhouse-mode
minor-mode:
(add-hook 'org-mode-hook #'org-clubhouse-mode nil nil)
Usage
In addition to updating the status of stories linked to clubhouse tickets, org-clubhouse provides the following commands:
org-clubhouse-create-story
Creates a new Clubhouse story from the current headline, or if a region of headlines is selected bulk-creates stories with all those headlinesorg-clubhouse-create-epic
Creates a new Clubhouse epic from the current headline, or if a region of headlines is selected bulk-creates epics with all those headlinesorg-clubhouse-create-story-with-task-list
Creates a Clubhouse story from the current headline, making all direct children of the headline into tasks in the task list of the storyorg-clubhouse-push-task-list
Writes each child element of the current clubhouse element as a task list item of the associated clubhouse ID.org-clubhouse-update-story-title
Updates the title of the Clubhouse story linked to the current headline with the text of the headlineorg-clubhouse-update-description
Update the status of the Clubhouse story linked to the current element with the contents of a drawer inside the element called DESCRIPTION, if any existsorg-clubhouse-headlines-from-query
Create org-mode headlines from a clubhouse query at the cursor's current position, prompting for the headline indentation level and clubhouse query textorg-clubhouse-claim
Adds the user configured inorg-clubhouse-username
as the owner of the clubhouse story associated with the headline at point
Configuration
Refer to the beginning of the org-clubhouse.el
file in this repository for
documentation on all supported configuration variables