nxs-go-redmine

This Go package provides access to Redmine API.

Compatible with Redmine 4.2+

Follows Redmine resources are fully implemented at this moment:

• Issues
• Projects
• Project Memberships
• Users
• Attachments
• Issue Statuses
• Trackers
• Enumerations
• Groups
• Custom Fields

Install

go get github.com/nixys/nxs-go-redmine/v3

Example of usage

You may find more examples in unit-tests in this repository

Get all projects from the Redmine server:

package main

import (
	"fmt"
	"os"

	"github.com/nixys/nxs-go-redmine/v3"
)

func main() {

	var r redmine.Context

	// Get variables from environment for connect to Redmine server 
	rdmnHost := os.Getenv("REDMINE_HOST")
	rdmnAPIKey := os.Getenv("REDMINE_API_KEY")
	if rdmnHost == "" || rdmnAPIKey == "" {
		fmt.Println("Init error: make sure environment variables `REDMINE_HOST` and `REDMINE_API_KEY` are defined")
		os.Exit(1)
	}

	// Init Redmine ctx 
	r.SetEndpoint(rdmnHost)
	r.SetAPIKey(rdmnAPIKey)

	fmt.Println("Init: success")

	// Get all projects 
	p, _, err := r.ProjectAllGet(ProjectAllGetRequest{
		Includes: []string{"trackers", "issue_categories", "enabled_modules"},
		Filters: ProjectGetRequestFilters{
			Status: ProjectStatusActive,
		},
	})
	if err != nil {
		fmt.Println("Projects get error:", err)
		os.Exit(1)
	}

	fmt.Println("Projects:")
	for _, e := range p.Projects {
		fmt.Println("-", e.Name)
	}
}

Run:

REDMINE_HOST="https://redmine.yourdomain.com" REDMINE_API_KEY="YOUR_API_KEY" go run main.go