timkicker
/
xfce4-dotfiles
mirror of https://github.com/timkicker/dotfiles
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
my xfce4 dotfiles
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 Commit
1 Branch
0 Tags
101 MiB
Tree: f3a7c7b26c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f3a7c7b26c'
${ noResults }
xfce4-dotfiles/.oh-my-zsh/plugins/jira/README.md

70 lines
2.9 KiB
Raw Normal View History

init repo
3 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. # Jira plugin #
  3. CLI support for JIRA interaction
  5. ## Description ##
  7. This plugin provides command line tools for interacting with Atlassian's [JIRA](https://www.atlassian.com/software/jira) bug tracking software.
  9. The interaction is all done through the web. No local installation of JIRA is necessary.
  11. In this document, "JIRA" refers to the JIRA issue tracking server, and `jira` refers to the command this plugin supplies.
  13. ## Usage ##
  15. This plugin supplies one command, `jira`, through which all its features are exposed. Most forms of this command open a JIRA page in your web browser.
  17. ```
  18. jira # performs the default action
  20. jira new # opens a new issue
  21. jira dashboard # opens your JIRA dashboard
  22. jira tempo # opens your JIRA Tempo
  23. jira reported [username] # queries for issues reported by a user
  24. jira assigned [username] # queries for issues assigned to a user
  25. jira myissues # queries for you own issues
  26. jira branch # opens an existing issue matching the current branch name
  27. # The branch name may have prefixes ending in "/": "feature/MP-1234",
  28. # and also suffixes starting with "_": "MP-1234_fix_dashboard"
  29. # In both these cases, the issue opened will be "MP-1234"
  30. jira ABC-123 # opens an existing issue
  31. jira ABC-123 m # opens an existing issue for adding a comment
  32. ```
  34. #### Debugging usage ####
  36. These calling forms are for developers' use, and may change at any time.
  38. ```
  39. jira dumpconfig # displays the effective configuration
  40. ```
  42. ## Setup ##
  44. The URL for your JIRA instance is set by `$JIRA_URL` or a `.jira_url` file.
  46. Add a `.jira-url` file in the base of your project. You can also set `$JIRA_URL` in your `~/.zshrc` or put a `.jira-url` in your home directory. A `.jira-url` in the current directory takes precedence, so you can make per-project customizations.
  48. The same goes with `.jira-prefix` and `$JIRA_PREFIX`. These control the prefix added to all issue IDs, which differentiates projects within a JIRA instance.
  50. For example:
  52. ```
  53. cd to/my/project
  54. echo "https://jira.atlassian.com" >> .jira-url
  55. ```
  57. (Note: The current implementation only looks in the current directory for `.jira-url` and `.jira-prefix`, not up the path, so if you are in a subdirectory of your project, it will fall back to your default JIRA URL. This will probably change in the future though.)
  59. ### Variables ###
  61. * `$JIRA_URL` - Your JIRA instance's URL
  62. * `$JIRA_NAME` - Your JIRA username; used as the default user for `assigned`/`reported` searches
  63. * `$JIRA_PREFIX` - Prefix added to issue ID arguments
  64. * `$JIRA_RAPID_BOARD` - Set to `true` if you use Rapid Board
  65. * `$JIRA_DEFAULT_ACTION` - Action to do when `jira` is called with no arguments; defaults to "new"
  68. ### Browser ###
  70. Your default web browser, as determined by how `open_command` handles `http://` URLs, is used for interacting with the JIRA instance. If you change your system's URL handler associations, it will change the browser that `jira` uses.