Golang Atlassian JIRA客户端交互插件库go-jira的使用

概述

go-jira是一个用于与Atlassian JIRA交互的Go客户端库。它提供了多种功能来与JIRA系统进行交互，包括创建和检索问题、管理问题状态转换等。

主要特性

• 认证支持（HTTP Basic、OAuth、Session Cookie、Bearer令牌）
• 创建和检索问题
• 创建和检索问题状态转换
• 调用所有JIRA API端点（即使该端点未在库中直接实现）

安装

使用go get安装：

go get github.com/andygrunwald/go-jira

使用示例

获取单个问题

package main

import (
    "fmt"
    jira "github.com/andygrunwald/go-jira"
)

func main() {
    jiraClient, _ := jira.NewClient(nil, "https://issues.apache.org/jira/")
    issue, _, _ := jiraClient.Issue.Get("MESOS-3325", nil)

    fmt.Printf("%s: %+v\n", issue.Key, issue.Fields.Summary)
    fmt.Printf("Type: %s\n", issue.Fields.Type.Name)
    fmt.Printf("Priority: %s\n", issue.Fields.Priority.Name)

    // 输出示例：
    // MESOS-3325: Running mesos-slave@0.23 in a container causes slave to be lost after a restart
    // Type: Bug
    // Priority: Critical
}

认证（使用API令牌）

package main

import (
    "context"
    "fmt"
    jira "github.com/andygrunwald/go-jira"
)

func main() {
    tp := jira.BasicAuthTransport{
        Username: "<username>",
        Password: "<api-token>",
    }

    client, err := jira.NewClient(tp.Client(), "https://my.jira.com")
    if err != nil {
        panic(err)
    }

    u, _, err := client.User.GetCurrentUser(context.Background())
    if err != nil {
        panic(err)
    }

    fmt.Printf("Email: %v\n", u.EmailAddress)
    fmt.Println("Success!")
}

创建问题

package main

import (
    "fmt"
    "github.com/andygrunwald/go-jira"
)

func main() {
    base := "https://my.jira.com"
    tp := jira.BasicAuthTransport{
        Username: "username",
        Password: "token",
    }

    jiraClient, err := jira.NewClient(tp.Client(), base)
    if err != nil {
        panic(err)
    }

    i := jira.Issue{
        Fields: &jira.IssueFields{
            Assignee: &jira.User{
                Name: "myuser",
            },
            Reporter: &jira.User{
                Name: "youruser",
            },
            Description: "Test Issue",
            Type: jira.IssueType{
                Name: "Bug",
            },
            Project: jira.Project{
                Key: "PROJ1",
            },
            Summary: "Just a demo issue",
        },
    }
    issue, _, err := jiraClient.Issue.Create(&i)
    if err != nil {
        panic(err)
    }

    fmt.Printf("%s: %+v\n", issue.Key, issue.Fields.Summary)
}

更改问题状态

package main

import (
    "fmt"
    "github.com/andygrunwald/go-jira"
)

func main() {
    testIssueID := "FART-1"
    base := "https://my.jira.com"
    tp := jira.BasicAuthTransport{
        Username: "username",
        Password: "token",
    }

    jiraClient, err := jira.NewClient(tp.Client(), base)
    if err != nil {
        panic(err)
    }

    issue, _, _ := jiraClient.Issue.Get(testIssueID, nil)
    currentStatus := issue.Fields.Status.Name
    fmt.Printf("Current status: %s\n", currentStatus)

    var transitionID string
    possibleTransitions, _, _ := jiraClient.Issue.GetTransitions(testIssueID)
    for _, v := range possibleTransitions {
        if v.Name == "In Progress" {
            transitionID = v.ID
            break
        }
    }

    jiraClient.Issue.DoTransition(testIssueID, transitionID)
    issue, _, _ = jiraClient.Issue.Get(testIssueID, nil)
    fmt.Printf("Status after transition: %+v\n", issue.Fields.Status.Name)
}

调用未实现的API端点

package main

import (
    "fmt"
    "github.com/andygrunwald/go-jira"
)

func main() {
    base := "https://my.jira.com"
    tp := jira.BasicAuthTransport{
        Username: "username",
        Password: "token",
    }

    jiraClient, err := jira.NewClient(tp.Client(), base)
    if err != nil {
        panic(err)
    }
    
    req, _ := jiraClient.NewRequest("GET", "rest/api/2/project", nil)

    projects := new([]jira.Project)
    _, err = jiraClient.Do(req, projects)
    if err != nil {
        panic(err)
    }

    for _, project := range *projects {
        fmt.Printf("%s: %s\n", project.Key, project.Name)
    }
}

注意事项

• 当前v2版本正在开发中，可能会有破坏性变更
• 如需稳定版本，请使用v1.*版本
• 支持Go >= 1.14
• 支持Jira v6.3.4和v7.1.2

更多信息

更多详细API描述请参考GoDoc文档。