README file from
GithubObsidian jira-issue
This plugin allows you to track the progress of Atlassian Jira issues from your Obsidian.md notes.
Documentation
Check out the complete documentation to start using Jira-Issue.
Installation
From the obsidian app go in Settings > Third-party plugins > Community Plugins > Browse and search for jira-issue.
Configuration
Use the plugin options to configure the connection to your Atlassian Jira server: host, username and password.
Markdown Syntax
The plugin support the following components:
📃jira-issue:
- Documentation
- Example:
```jira-issue
AAA-111
AAA-222
https://my.jira-server.com/browse/BBB-333
# This is a comment
```
🔎jira-search
- Documentation
- Simple example:
```jira-search
resolution = Unresolved AND assignee = currentUser() AND status = 'In Progress' order by priority DESC
```
- Advanced example:
```jira-search
type: TABLE
query: status = 'In Progress' order by priority DESC
limit: 15
columns: KEY, SUMMARY, -ASSIGNEE, -REPORTER, STATUS, NOTES
```
🔢jira-count
- Documentation
- Example:
```jira-count
project = REF AND status changed to (Done, "Won't Fix", Archived, "Can't Reproduce", "PM Validated") after -14d
```
🏷️Inline issues
- Documentation
- Example:
With inline issue you can insert an issue like JIRA:OPEN-351 inside your text.
The plugin will detect urls like https://jira.secondlife.com/browse/OPEN-352 and render the issue as tags.
- [ ] Issue can be extended JIRA:OPEN-353 with the summary
- [x] Or compact JIRA:-OPEN-354 without the summary
- [ ] JIRA:-OPEN-355 use the `-` symbol before the issue key to make it compact
```
The plugin searches inside the note for those patterns and replace them
JIRA:-OPEN-356
```
Contribution and Feedbacks
Feel free to share your experiences, feedbacks and suggestions in the by opening a GitHub issue.
Pull requests are welcome.
License
Jira-Issue is licensed under the GNU AGPLv3 license. Refer to LICENSE for more information.