Skip to content

essentialkaos/sonar

GoReportCard Code Climate Maintainability codebeat badge GitHub Actions CI Status GitHub Actions CodeQL Status

InstallationBuild StatusContributingLicense


Sonar is a utility for showing user Slack status in Atlassian Jira.

Screenshots

Sonar Preview Sonar in Jira 6.x (with Remixed Theme)

Installation

sudo yum install -y https://yum.kaos.st/kaos-repo-latest.el$(grep 'CPE_NAME' /etc/os-release | tr -d '"' | cut -d':' -f5).noarch.rpm
sudo yum install sonar

Slack app

Create classic Slack App (this application requires RTM and can't work with socket mode due to lack of presence events).

Add next OAuth scopes to your app:

  • dnd:read
  • users:read

Integration with Jira

Go to atlassian-jira/WEB-INF/classes/templates/plugins/userformat and modify next files.

actionProfileLink.vm

<a $!{userHoverAttributes} id="$!{id}" href="${baseurl}/secure/ViewProfile.jspa?name=${velocityhelper.urlencode($username)}">${renderedAvatarImg} ${author}</a><img class="slack-status" src="https://sonar.domain.com/status.svg?token=YOUR_TOKEN_HERE&mail=$user.emailAddress" />

profileLinkWithAvatar.vm

${textutils.htmlEncode($fullname)}<img class="slack-status" src="https://sonar.domain.com/status.svg?token=YOUR_TOKEN_HERE&mail=$user.emailAddress" />

avatarFullNameHover.vm

$textutils.htmlEncode($fullname)
<img class="slack-status" src="https://sonar.domain.com/status.svg?token=YOUR_TOKEN_HERE&mail=$user.emailAddress" />

Then restart your Jira instance.

Also, you can add sonar.js to your announcement banner for a periodic status update.

Build Status

Branch Status
master CI
develop CI

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0