Skip to content

CHANGELOG.md

Latest commit

 

History

History
282 lines (191 loc) · 18.2 KB

CHANGELOG.md

File metadata and controls

282 lines (191 loc) · 18.2 KB

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.0 (UNRELEASED)

Version 2.0 is a bigger change with the main goal to make this library more reliable and future safe. See #489 for details.

For detailed migration instructions from v1.x to v2.0, see MIGRATE.md.

Breaking changes

  • Jira On-Premise and Jira Cloud have now different clients, because the API differs
  • client.NewRawRequestWithContext() has been removed in favor of client.NewRawRequest(), which requires now a context as first argument
  • client.NewRequestWithContext() has been removed in favor of client.NewRequest(), which requires now a context as first argument
  • client.NewMultiPartRequestWithContext() has been removed in favor of client.NewMultiPartRequest(), which requires now a context as first argument
  • context is now a first class citizen in all API calls. Functions that had a suffix like ...WithContext have been removed entirely. The API methods support the context now as first argument.
  • BoardService.GetAllSprints has been removed and BoardService.GetAllSprintsWithOptions has been renamed to BoardService.GetAllSprints
  • GroupService.Get has been removed and GroupService.GetWithOptions has been renamed to GroupService.Get
  • Issue.Update has been removed and Issue.UpdateWithOptions has been renamed to Issue.Update
  • Issue.GetCreateMeta has been removed and Issue.GetCreateMetaWithOptions has been renamed to Issue.GetCreateMeta
  • Project.GetList has been removed and Project.ListWithOptions has been renamed to Project.GetAll
  • Cloud/Authentication: Removed BearerAuthTransport, because it was a (kind of) duplicate of BasicAuthTransport
  • Cloud/Authentication: Removed PATAuthTransport, because it was a (kind of) duplicate of BasicAuthTransport
  • Cloud/Authentication: BasicAuthTransport.Password was renamed to BasicAuthTransport.APIToken
  • Cloud/Authentication: Removes CookieAuthTransport and AuthenticationService, because this type of auth is not supported by the Jira cloud offering
  • Cloud/Component: The type CreateComponentOptions was renamed to ComponentCreateOptions
  • Cloud/User: Renamed User.GetSelf to User.GetCurrentUser
  • Cloud/Group: Renamed Group.Add to Group.AddUserByGroupName
  • Cloud/Group: Renamed Group.Remove to Group.RemoveUserByGroupName

Features

  • UserAgent: Client HTTP calls are now identifable via a User Agent. This user agent can be configured (default: go-jira/2.0.0)
  • The underlying used HTTP client for API calls can be retrieved via client.Client()
  • API-Version: Official support for Jira Cloud API in version 3

Bug Fixes

  • README: Fixed all (broken) links

API-Endpoints

  • Workflow status categories: Revisited and fully implemented for Cloud and On Premise (incl. examples)

Other

  • Replace all "GET", "POST", ... with http.MethodGet (and related) constants
  • Development: Added make commands to collect (unit) test coverage
  • Internal: Replaced io.ReadAll and json.Unmarshal with json.NewDecoder

1.17.0 (2025-09-16)

All changes in #735.

Breaking Changes

  • Minimum Go version increased from 1.15 to 1.21 (due to google/go-cmp dependency update)

Security

  • Updated github.com/golang-jwt/jwt/v4 v4.4.2 to v4.5.2 (CVE-2025-30204)

Maintenance

  • Replaced deprecated ioutil.ReadFile with os.ReadFile
  • Replaced deprecated ioutil.ReadAll with io.ReadAll
  • Replaced deprecated ioutil.Discard with io.Discard
  • Upgraded staticcheck v2022.1 to v2023.1
  • Code formatting updates (issue.go, metaissue.go, sprint.go)

Dependencies

  • github.com/google/go-cmp v0.5.8 to v0.7.0
  • github.com/golang-jwt/jwt/v4 v4.4.2 to v4.5.2

CI/CD

  • Upgraded actions/checkout from v3 to v5
  • Upgraded actions/setup-go from v3 to v6
  • Upgraded dominikh/staticcheck-action from v1.2 to v1.4

1.16.1 (2025-09-13)

Features

  • Added IssueService.SearchV2JQL() and IssueService.SearchV2JQLWithContext() to handle Atlassian's deprecation of GET /rest/api/2/search endpoint (effective October 31, 2024) (#725)

New contributor: @conor-naranjo

1.16.0 (2022-07-08)

Features

  • Added example demonstrating how to add labels to issues (#442)

Maintenance

  • Test matrix expanded to include macOS (#449)
  • Deprecated Go v1.15 and Go v1.16; added Go v1.18 (#449)
  • Implemented nightly CI runs (#449)
  • Removed greetings workflow (#450)
  • Upgraded staticcheck action to v1.2.0 (#451)

Dependencies

  • github.com/golang-jwt/jwt/v4 v4.3.0 to v4.4.2 (#443, #445, #464)
  • github.com/google/go-cmp v0.5.7 to v0.5.8 (#453)
  • actions/checkout v2 to v3 (#448)
  • actions/cache v2 to v3.0.1 (#447)
  • actions/setup-go v2 to v3 (#452)

New contributor: @lucribas

1.15.1 (2022-02-26)

Features

  • Added customer and request endpoints for Service Desk API (#391)
  • Added "environment" field to Issue struct (#440)
  • User module improvements (#439)

Bug Fixes

  • Added support for update section in DoTransitionWithPayload struct (#423)
  • Fixed resource leaks (#399)

New contributors: @CondensedTea, @nansuri, @metalbreeze, @iamjem, @dustin-decker

1.15.0 (2022-02-18)

Features

  • Upgraded to JWT Library V4 (#403)
  • Added Bearer token support for OAuth 2.0 (#397)
  • Added Personal Access Token (PAT) authentication support (#422)
  • Added method for updating remote issue links by ID (#411)
  • Added support for ServiceDeskID as strings (#419)
  • Added missing min/max properties to BoardConfigurationColumn (#430)

Bug Fixes

  • Fixed missing struct omitempty tags in Parent struct (#435)

Documentation

  • Fixed import alias example in README (#428)

Dependencies

  • github.com/golang-jwt/jwt/v4 v4.1.0 to v4.3.0 (#424, #438)
  • github.com/google/go-cmp v0.5.6 to v0.5.7 (#432)

1.14.0 (2021-07-28)

Features

  • Added description field for component (#365)
  • Added Jira ServiceDesk support with organizations (#342)
  • Implemented delete issue link API (#341)
  • Added Items and Custom properties to FieldSchema (#332)
  • Added StartedAfter property to GetWorklogsQueryOptions (#344)

Bug Fixes

  • Fixed potential nil reference issues (#342)
  • Fixed context parameter propagation (#363)
  • Fixed variable total calculation in pagination example (#354)
  • Fixed boolean type handling for release versions (#336)
  • Fixed RemoteLinkStatus (#303)

Documentation

  • Updated examples to use accountID instead of deprecated username (#374)
  • Added example for creating issues with custom fields (#358)
  • Fixed examples/create response output (#357)
  • Added pagination example (#354)
  • Switched examples from deprecated terminal.ReadPassword to term.ReadPassword (#359)

Maintenance

  • CI/CD workflow cleanup (#384)
  • Added funding information (#383)
  • Upgraded to GitHub-native Dependabot (#375)
  • Resolved nogo tautological linting error (#364)
  • Updated Go versions in testing workflow (#349)

Dependencies

  • JWT library upgrade (#387)
  • github.com/google/go-cmp v0.3.0 to v0.5.6 (#347, #360, #379)
  • github.com/pkg/errors v0.8.0 to v0.9.1 (#345)
  • github.com/trivago/tgo v1.0.1 to v1.0.7 (#346)
  • github.com/fatih/structs v1.0.0 to v1.1.0 (#348)

1.13.0 (2020-10-25)

Features

Bug Fixes

  • change millisecond time format (8c77107)
  • paging with load balancer going to endless loop (19d3fc0), closes #260
  • issue: IssueService.Search() with a not empty JQL triggers 400 bad request (#292) (8b64c7f), closes #291
  • IssueService.GetWatchers: UserService.GetByAccountID support accountId params (436469b)
  • product: Make product naming consistent, rename JIRA to Jira (#286) (146229d), closes #284
  • tests: Fix TestIssueService_PostAttachment unit test (f6b1dca)
  • removing the use of username field in searching for users (#297) (f50cb07)

1.12.0 (2019-12-14)

Features

  • Add IssueLinkTypeService with GetList and test (261889a)
  • add worklog update method (9ff562a)
  • Implement get remote links method (1946cac)
  • Implement issue link type DELETE (e37cc6c)
  • Implement issue link type GET (57538b9)
  • Implement issue link type POST (75b9df8)
  • Implement issue link type PUT (48a15c1)
  • provide access to issue transitions loaded from JIRA API (7530b7c)

1.11.1 (2019-10-17)

1.11.0 (2019-10-17)

Features

  • Add AccountID and AccountType to GroupMember struct (216e005)
  • Add AccountType and Locale to User struct (52ab347)
  • Add GetAllStatuses (afc96b1)
  • Add GetMyFilters to FilterService (ebae19d)
  • Add Search to FilterService (38a755b)
  • add support for JWT auth with qsh needed by add-ons (a8bdfed)
  • AddGetBoardConfiguration (fd698c5)
  • Replace http.Client with interface for extensibility (b59a65c)

Bug Fixes

  • Fix fixversion description tag (8383e2f)
  • Fix typos in filter_test.go (e9a261c)

1.10.0 (2019-05-23)

Bug Fixes

  • empty SearchOptions causing malformed request (b3bf8c2)

Features

1.9.0 (2019-05-19)

Features

  • issues: Added support for AddWorklog and GetWorklogs (1ebd7e7)

1.8.0 (2019-05-16)

Bug Fixes

  • Add PriorityService to the main (8491cb0)

Features

  • filter: Add GetFavouriteList to FilterService. (645898e)
  • Add get all priorities (1c63e25)
  • Add ResolutionService to retrieve resolutions (fb1ce22)
  • Add status category constants (6223ddd)
  • Add StatusCategory GetList (049a756)