WARNING: I moved my notes to Obsidian.md and I will not provide additional support to this plugin. Pull requests are welcome.
This plugin allows you to track the progress of Atlassian Jira issues from your Joplin notes.
Use the Joplin plugin manager to install it (Joplin > Options > Plugins)
- Download the last release from this repository.
- Open
Joplin > Options > Plugins > Install from File - Select the jpl file you downloaded.
In the option menu you must configure the connection to your company Atlassian Jira server: host, username and password.
There are three authentication methods:
- Open: username and password fields must be empty.
- Basic: username and password fields must be filled.
- Bearer: username field must be empty and password field must contain the token.
Is it possible to track an issue in two ways:
| Type | Markdown Syntax | Rendering |
|---|---|---|
| Inline | <JiraIssue key="STORM-2055"> |
 |
| Block | ```jira-issue OPEN-19 # This is a comment https://jira.secondlife.com/browse/STORM-1909 STORM-2334 ``` |
 |
In order to view more details about the issue it is possible to expand it:
Is it possible to show the results of JQL query in a table using one of the following syntax
<JiraSearch jql="resolution = Unresolved AND assignee = currentUser() AND status = 'In Progress' order by priority DESC">
```jira-search # This is a comment resolution = Unresolved AND assignee = currentUser() AND status = 'In Progress' order by priority DESC # Here another query status = 'Open' order by priority DESC ```
If you don't remember the syntax to create a JiraIssue or a JiraSearch block you can use the templates in the tools menu and context menu
- If you need to use the double quotes (
") in the JiraSearch inline query you can replace them with (') or the html tag" - The tag names are case insensitive
- This plugin is modifying the HTML rendering of the markdown so the WYSIWYG editor is not supported
If you want to contribute to this plugin you can find here some useful references:
- Joplin - Getting started with plugin development
- Joplin - Plugin API reference
- Joplin - Data API reference
- Joplin - Plugin examples
In case of node.js v17 or above, set this flag to install the dependencies while running them with git bash:
export NODE_OPTIONS=--openssl-legacy-provider
npm install