andygrunwald / go-jira

Go client library for Atlassian Jira

Home Page:https://pkg.go.dev/github.com/andygrunwald/go-jira?tab=doc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Development is kicking: Road to v2 πŸš€

andygrunwald opened this issue Β· comments

Hey all,

The current state

This library was created in August 2015.

Since then, a lot has moved in the Go and Atlassian JIRA ecosystem.
Not only technical things like the context package (in Go) but also business decisions from Atlassian are affecting this library (cloud vs. on-premise, different APIs, etc.)

Over time, these library has developed some flaws which make it hard to develop reliable applications.

Additionally, the development slowed down due to less time for the maintainers.
The result: A lot of unanswered issues and open pull requests.
We feel sorry for this.

What is happening now?

We aim to restart the development again.
Our goal is to be the standard Go library to interact with Jira.

We crafted a Milestone https://github.com/andygrunwald/go-jira/milestone/1

This Milestone, version 2, should re-work this library a bit to match standard reliability requirements, idiomatic go, and bring it to the latest state of best practices.

This will include several breaking changes.

How we plan to do it

v1.* will be discontinued.
It is usable but with flaws.

It will take some time until v2.* is production ready.
In the meantime, we plan to release v2.*-alpha versions regularly.
Those alpha-versions might not be stable and will suffer from additional breaking changes.
However, by switching to those, you will benefit from the new setup, and we plan to provide migration plans all the time.

Let us know what you think

This ticket is also a plan to get your input on this plan.
Let us know what you think and post your feedback into this issue.

@andygrunwald: many thanks for all this work. Just a suggestion: I think it could beneficial to open a GitHub discussion for this issue and also use a GitHub Project to keep track of all the referenced issues.

@marcelosousa This sounds like a good idea.

Project

We have a Milestone: https://github.com/andygrunwald/go-jira/milestone/1
Not sure if a Project would add more benefits. Feel free to challenge me on this :)

Discussion

Can be found here: #501