adyscorpius / logseq-jira Goto Github PK

A simple Jira plugin for Logseq users

License: MIT License

HTML 3.11% TypeScript 96.89%

logseq-jira's Introduction

Logseq Jira Sync Plugin

Are you tired of copying Jira links, only to not remember which Jira is it? What about getting updates without clicking on each link? Or querying blocks within Logseq based on ticket status?

Bring your Jira issue status and summaries into Logseq with Logseq-Jira. Include important fields like Priority, Status, Assignee and Reporter as block properties to then query within Logseq as needed.

Check out the discussion on Logseq Forums by clicking here

What it does?

Current Functionality

Use the slash command "Update Jira Issue" to replace issue keys (PM-100, ISS-12143, etc.) or Jira issue links like subdomain.atlassian.net/browse/PM-100 with [<issueKey>|<issueSummary>](https://orgname.atlassian.net/browse/<issueKey>) formats.
Use optional block properties to keep the text as in, but add key issue fields as block properties.
NEW Supports two Jira Cloud instances. Keep your work JIRA separate from your personal JIRA.

Known Limitations

Earlier issue details are not automatically updated. (Need to check performance impact).
Supports Jira Cloud only.

Roadmap

Refresh summary on rerun on existing links.
Add more fields to help with context of the tickets
Support for multiple organizations.
Auto refresh/update all links when page is loaded.
Auto refresh all Jira links across vault (need to verify performance impact on doing this).
Create your own Link description format with Jira variables ( '{issueKey} - {status} - {summary}' )

Download

The plugin is available to download directly from Logseq's Plugins marketplace. Alternatively, you can download the latest release from Releases published on Github.

How to build the plugin

Git clone the repository to your local system. Or download and extract to a known path.
npm install && npm run build in terminal to install dependencies and generate distribution folder.
Enable Developer mode in Logseq by going to Settings -> Advanced -> Turn on Developer Mode.
Load unpacked plugin in Logseq Desktop client and select the folder for the plugin on your disk.
For updates, git pull the main branch and 'Reload Package' under Plugins > Logseq Jira.

Release process

Update version in package.json
Add all updates to master branch
Tag the latest commit with new version.

logseq-jira's People

Contributors

Stargazers

Watchers

Forkers

dv-adit ataka cuevaskoch veraposeidon dang312 kartiksayani nightscape marnoot loveskylark jesse0099 scriptingdad

logseq-jira's Issues

Support org-mode

Hi!
First of all, thanks for your work!
When using the plugin, I've seen that it automatically creates the link in Markdown format. It would be nice if there'd be an option in the configuration that lets you choose between markdown or org-mode.
The format link in org-mode is the next:

[[https://example.link][Example description]]

Thanks again! If you need more information, just ask.

Mixed line endings in repo

Hi @adyscorpius, this might come off as super-nitpicky, but some files have different line endings:

git ls-files --eol
i/lf    w/lf    attr/                   .github/workflows/publish.yml
i/lf    w/lf    attr/                   .gitignore
i/lf    w/lf    attr/                   CODE_OF_CONDUCT.md
i/lf    w/lf    attr/                   LICENSE
i/crlf  w/crlf  attr/                   README.md
i/-text w/-text attr/                   demo.gif
i/-text w/-text attr/                   jira.png
i/lf    w/lf    attr/                   package-lock.json
i/lf    w/lf    attr/                   package.json
i/crlf  w/crlf  attr/                   src/index.html
i/crlf  w/crlf  attr/                   src/index.ts
i/lf    w/lf    attr/                   src/settings.ts
i/lf    w/lf    attr/                   tsconfig.json

I'm just trying to rebase my PR #6, but I'm having a hard time convincing VS Code to not replace the crlf with lf while still keeping my changes.
Personally, I always enable autocrlf and haven't had any line ending problems ever since:

git config --global core.autocrlf input

Here's some documentation on how to get rid of the mixed line endings.

How to troubleshoot

First of all thanks a lot for this plugin. When it will hopefully work it's exactly what I've missed. Unfortunately, it does not work. After installation I added a JIRA token and URL in the settings. But when I use the slash command nothing happens. No error message, no success message. In order to fix this I would like to ask for some hints what I can check or do in order to fix this. Thx :-)

Support hosted Jira instances with personal access tokens?

maybe a feature request?

https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html

Plugin reports an error "Couldn't find a valid Jira issue key."

I'm using version 0.0.9 of the plugin. It worked as expected this morning, but after I upgraded Logseq to v0.9.5 I now consistently get the following error when trying to invoke the plugin: "Couldn't find a valid Jira issue key."

I'm not sure if the Logseq upgrade affected the plugin, or if it's a coincidence.

I regenerated a new Jira API token, but the issue remains.

v0.0.8 - Bug with Logseq causing block text not to update.

In v0.0.8, while block properties get added, the main text doesn't update. This relates to a bug in Logseq tracked here..

Using upsertBlockProperty after updateBlock resets update back to previous value

Waiting for the issue to be fixed to automatically fix this issue.