Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.72 KB

README.org

File metadata and controls

57 lines (38 loc) · 2.72 KB

https://melpa.org/packages/org-pivotal-badge.svg https://circleci.com/gh/org-pivotal/org-pivotal/tree/master.svg?style=svg https://coveralls.io/repos/github/org-pivotal/org-pivotal/badge.svg?branch=master https://img.shields.io/badge/License-GPL%20v3-blue.svg http://hits.dwyl.io/org-pivotal/org-pivotal.svg https://img.shields.io/badge/Maintained%3F-yes-green.svg https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

Summary

org-pivotal is a utility to extend org-mode with Pivotal Tracker abilities

Screen shots

https://github.com/org-pivotal/org-pivotal.github.io/blob/master/assets/screen_shot.png

Initial setup

Before using the tracker you must setup your pivotal API key in Emacs. You can obtain the key from the Profile link in the Pivotal Tracker web application.

After obtaining the ky, you have to manually add it to your .emacs.d or .spacemacs like this:

(setq org-pivotal-api-token "your-secret-token")

If you don’t want to set it directly in your Emacs’s .el file, you can export it to shell environment and use getenv to read it from within Emacs

(setq org-pivotal-api-token (getenv "PIVOTAL_API_TOKEN"))

To enable this package automatically after opening org-mode, add this line to your Emacs’s .el file

(add-hook 'org-mode-hook 'org-pivotal-mode)

Keybindings

KeybindingsInteractive commandsDescription
C-c ( iM-x org-pivotal-install-project-metadataInstall selected project’s metadata to buffer
C-c ( fM-x org-pivotal-pull-storiesPull stories to org buffer
C-c ( pM-x org-pivotal-push-storyPush current story to Pivotal
C-c ( tM-x org-pivotal-pull-story-tasksPull current story’s tasks

Contributing

Yes, please do! See CONTRIBUTING for guidelines.

License

See COPYING. Copyright (c) 2018 Huy Duong.

Roadmap

https://www.pivotaltracker.com/n/projects/2451706