Modules@robinpath/jira

@robinpath/jira

0.1.0Public

Jira module for RobinPath.

@robinpath/jira

Jira module for RobinPath.

Category Functions Auth License

Why use this module?

The jira module lets you:

  • Create a new Jira issue.
  • Get a Jira issue by key.
  • Update fields on a Jira issue.
  • Delete a Jira issue.
  • Assign a Jira issue to a user.

All functions are callable directly from RobinPath scripts with a simple, consistent API.

Installation

npm install @robinpath/jira

Quick Start

1. Set up credentials

jira.setCredentials "mycompany.atlassian.net" "user@example.com" "your-api-token"

2. Create a new Jira issue.

jira.createIssue "PROJ" "Task" "Fix login bug" {"description":"Login page returns 500","priority":"High"}

Available Functions

FunctionDescription
jira.setCredentialsSet Jira Cloud credentials for API access.
jira.createIssueCreate a new Jira issue.
jira.getIssueGet a Jira issue by key.
jira.updateIssueUpdate fields on a Jira issue.
jira.deleteIssueDelete a Jira issue.
jira.assignIssueAssign a Jira issue to a user.
jira.transitionIssueTransition a Jira issue to a new status.
jira.addCommentAdd a comment to a Jira issue.
jira.getCommentsList comments on a Jira issue.
jira.searchIssuesSearch Jira issues using JQL.
jira.listProjectsList all accessible Jira projects.
jira.getProjectGet details of a Jira project.
jira.listBoardsList Jira agile boards.
jira.getBoardSprintsGet sprints for a Jira board.
jira.getSprintIssuesGet issues in a sprint.
jira.addLabelAdd a label to a Jira issue.
jira.removeLabelRemove a label from a Jira issue.
jira.getTransitionsGet available status transitions for a Jira issue.
jira.addAttachmentAdd a file attachment to a Jira issue.
jira.listUsersSearch for Jira users.
jira.getUserGet a Jira user by account ID.
jira.addWatcherAdd a watcher to a Jira issue.
jira.removeWatcherRemove a watcher from a Jira issue.
jira.listPrioritiesList all available Jira priorities.
jira.listIssueTypesList available issue types, optionally filtered by project.

Examples

Create a new Jira issue.

jira.createIssue "PROJ" "Task" "Fix login bug" {"description":"Login page returns 500","priority":"High"}

Get a Jira issue by key.

jira.getIssue "PROJ-123"

Update fields on a Jira issue.

jira.updateIssue "PROJ-123" {"summary":"Updated summary","priority":{"name":"High"}}

Integration with RobinPath

import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/jira";

const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);

const result = await rp.executeScript(`
  jira.setCredentials "mycompany.atlassian.net" "user@example.com" "your-api-token"
  jira.createIssue "PROJ" "Task" "Fix login bug" {"description":"Login page returns 500","priority":"High"}
`);

Full API Reference

See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.

Related Modules

License

MIT

Versions (1)

VersionTagPublished
0.1.0latestyesterday
Install
$ robinpath install @robinpath/jira
Version0.1.0
LicenseMIT
Unpacked Size8.5 KB
Versions1
Weekly Downloads0
Total Downloads0
Stars0
Last Publishyesterday
Createdyesterday

Category

productivity