Install on Jira
Installing takes about two minutes. You need to be a Jira site admin on a Jira Cloud site. Cuelight doesn't run on Jira Data Center or Server.
1. Get the app
Open Cuelight for Jira on the Atlassian Marketplace and choose
Try it free. Pick your site, like acme.atlassian.net, and confirm. Sites with up to 10 users
use it for free; larger sites get a 30-day trial. See Pricing.
2. Review what it asks for
Jira shows what the app can do before it installs. Cuelight asks for these:
| Permission | What Cuelight uses it for |
|---|---|
| Read Jira work | Show the right buttons for a work item's project, type, status, labels |
| Write Jira work | Add audit comments, labels and field values when a button asks for it |
| Read Jira users and groups | Check if the person pressing a button is in the allowed groups |
| App storage | Keep your settings, runs and next steps inside your Atlassian site |
| Report personal data | Tell Atlassian which people it stores, so deleted accounts are removed |
Connect to api.github.com | Start workflows and read their status. It talks to nothing else |
Choose Install. Jira installs it in a few seconds.
3. Find it
Cuelight shows up in two places.
- For admins: settings. Go to Settings (gear icon) → Apps, then Cuelight in the left menu. Setup starts here.
- For everyone: the panel. Open a work item. The Next steps panel is in the right column. Until an action applies, it says "No actions for this work item." Admins also see a Set up actions link.
4. Follow the Setup tab
The Setup tab in Cuelight settings is a checklist. Most items turn to Done by themselves when you finish them on their tab:
- Connect GitHub. Paste a GitHub token that can start workflows. See GitHub setup.
- Map a Jira project to a repository. Like
SHOP→acme/shop. - Add at least one action. Start from a template, like Deploy to staging.
- Copy the report URL into your workflows. Only needed for offers from other tools. Tick it yourself.
- Run your first action from a work item. Open a work item and press the button.
Getting started walks through each step with the JSON and the workflow file you need.
Who else needs to do anything
Nobody. People who use Jira don't install anything and don't need a GitHub account. They see the panel on work items as soon as an admin adds actions. Jira groups decide who can press which button (Rules and permissions).
Updates
Minor updates install themselves. If a new version needs a new permission, Jira shows a banner under Settings → Apps → Manage apps and waits for an admin to approve it. Until then the old version keeps working. The changelog lists what changed.
Remove it
Go to Settings → Apps → Manage apps, find Cuelight for Jira and choose Uninstall. Buttons disappear from work items at once. Comments Cuelight already added stay, like any other comment. Cuelight's settings, runs and next steps live in the app's Forge storage, which Atlassian removes under its retention rules. See Privacy.