Skip to content

G
go-gitlab
Commit 7d64e347 authored by Juhani Ränkimies's avatar Juhani Ränkimies
Browse files
Options

BREAKING CHANGE: Rename release types in Tags service 

Gitlab 11.7 introduces a new Releases api and deprecates
release support in Tags api. Release type  and associated
methods in Tags api are renamed to make the name
available for Releases api

https://docs.gitlab.com/ee/api/releases/index.html
https://docs.gitlab.com/ee/api/releases/links.html
https://docs.gitlab.com/ee/api/tags.html
parent a177ae6d
Hide whitespace changes
Inline Side-by-side
Showing with 45 additions and 36 deletions
tags.go
View file @ 7d64e347
......@@ -33,16 +33,16 @@ type TagsService struct {
//
// GitLab API docs: https://docs.gitlab.com/ce/api/tags.html
type Tag struct {
Commit *Commit `json:"commit"`
Release *Release `json:"release"`
Name string `json:"name"`
Message string `json:"message"`
Commit *Commit `json:"commit"`
Release *ReleaseNote `json:"release"`
Name string `json:"name"`
Message string `json:"message"`
}
// Release represents a GitLab version release.
// ReleaseNote represents a GitLab version release.
//
// GitLab API docs: https://docs.gitlab.com/ce/api/tags.html
type Release struct {
type ReleaseNote struct {
TagName string `json:"tag_name"`
Description string `json:"description"`
}
......@@ -118,9 +118,10 @@ func (s *TagsService) GetTag(pid interface{}, tag string, options ...OptionFunc)
// GitLab API docs:
// https://docs.gitlab.com/ce/api/tags.html#create-a-new-tag
type CreateTagOptions struct {
TagName *string `url:"tag_name,omitempty" json:"tag_name,omitempty"`
Ref *string `url:"ref,omitempty" json:"ref,omitempty"`
Message *string `url:"message,omitempty" json:"message,omitempty"`
TagName *string `url:"tag_name,omitempty" json:"tag_name,omitempty"`
Ref *string `url:"ref,omitempty" json:"ref,omitempty"`
Message *string `url:"message,omitempty" json:"message,omitempty"`
// ReleaseDescription parameter was deprecated in GitLab 11.7
ReleaseDescription *string `url:"release_description:omitempty" json:"release_description,omitempty"`
}
......@@ -168,20 +169,24 @@ func (s *TagsService) DeleteTag(pid interface{}, tag string, options ...OptionFu
return s.client.Do(req, nil)
}
// CreateReleaseOptions represents the available CreateRelease() options.
// CreateReleaseNoteOptions represents the available CreateReleaseNote() options.
//
// Deprecated: This feature was deprecated in GitLab 11.7.
//
// GitLab API docs:
// https://docs.gitlab.com/ce/api/tags.html#create-a-new-release
type CreateReleaseOptions struct {
type CreateReleaseNoteOptions struct {
Description *string `url:"description:omitempty" json:"description,omitempty"`
}
// CreateRelease Add release notes to the existing git tag.
// CreateReleaseNote Add release notes to the existing git tag.
// If there already exists a release for the given tag, status code 409 is returned.
//
// Deprecated: This feature was deprecated in GitLab 11.7.
//
// GitLab API docs:
// https://docs.gitlab.com/ce/api/tags.html#create-a-new-release
func (s *TagsService) CreateRelease(pid interface{}, tag string, opt *CreateReleaseOptions, options ...OptionFunc) (*Release, *Response, error) {
func (s *TagsService) CreateReleaseNote(pid interface{}, tag string, opt *CreateReleaseNoteOptions, options ...OptionFunc) (*ReleaseNote, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
......@@ -193,7 +198,7 @@ func (s *TagsService) CreateRelease(pid interface{}, tag string, opt *CreateRele
return nil, nil, err
}
r := new(Release)
r := new(ReleaseNote)
resp, err := s.client.Do(req, r)
if err != nil {
return nil, resp, err
......@@ -202,19 +207,21 @@ func (s *TagsService) CreateRelease(pid interface{}, tag string, opt *CreateRele
return r, resp, err
}
// UpdateReleaseOptions represents the available UpdateRelease() options.
// UpdateReleaseNoteOptions represents the available UpdateReleaseNote() options.
//
// GitLab API docs:
// https://docs.gitlab.com/ce/api/tags.html#update-a-release
type UpdateReleaseOptions struct {
type UpdateReleaseNoteOptions struct {
Description *string `url:"description:omitempty" json:"description,omitempty"`
}
// UpdateRelease Updates the release notes of a given release.
// UpdateReleaseNote Updates the release notes of a given release.
//
// Deprecated: This feature was deprecated in GitLab 11.7.
//
// GitLab API docs:
// https://docs.gitlab.com/ce/api/tags.html#update-a-release
func (s *TagsService) UpdateRelease(pid interface{}, tag string, opt *UpdateReleaseOptions, options ...OptionFunc) (*Release, *Response, error) {
func (s *TagsService) UpdateReleaseNote(pid interface{}, tag string, opt *UpdateReleaseNoteOptions, options ...OptionFunc) (*ReleaseNote, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
......@@ -226,7 +233,7 @@ func (s *TagsService) UpdateRelease(pid interface{}, tag string, opt *UpdateRele
return nil, nil, err
}
r := new(Release)
r := new(ReleaseNote)
resp, err := s.client.Do(req, r)
if err != nil {
return nil, resp, err
......
tags_test.go
View file @ 7d64e347
......@@ -7,7 +7,7 @@ import (
"testing"
)
func TestListTags(t *testing.T) {
func TestTagsService_ListTags(t *testing.T) {
mux, server, client := setup()
defer teardown(server)
......@@ -29,45 +29,47 @@ func TestListTags(t *testing.T) {
}
}
func TestCreateRelease(t *testing.T) {
func TestTagsService_CreateReleaseNote(t *testing.T) {
mux, server, client := setup()
defer teardown(server)
mux.HandleFunc("/api/v4/projects/1/repository/tags/1.0.0/release", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "POST")
fmt.Fprint(w, `{"tag_name": "1.0.0", "description": "Amazing release. Wow"}`)
})
mux.HandleFunc("/api/v4/projects/1/repository/tags/1.0.0/release",
func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "POST")
fmt.Fprint(w, `{"tag_name": "1.0.0", "description": "Amazing release. Wow"}`)
})
opt := &CreateReleaseOptions{Description: String("Amazing release. Wow")}
opt := &CreateReleaseNoteOptions{Description: String("Amazing release. Wow")}
release, _, err := client.Tags.CreateRelease(1, "1.0.0", opt)
release, _, err := client.Tags.CreateReleaseNote(1, "1.0.0", opt)
if err != nil {
t.Errorf("Tags.CreateRelease returned error: %v", err)
}
want := &Release{TagName: "1.0.0", Description: "Amazing release. Wow"}
want := &ReleaseNote{TagName: "1.0.0", Description: "Amazing release. Wow"}
if !reflect.DeepEqual(want, release) {
t.Errorf("Tags.CreateRelease returned %+v, want %+v", release, want)
}
}
func TestUpdateRelease(t *testing.T) {
func TestTagsService_UpdateReleaseNote(t *testing.T) {
mux, server, client := setup()
defer teardown(server)
mux.HandleFunc("/api/v4/projects/1/repository/tags/1.0.0/release", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "PUT")
fmt.Fprint(w, `{"tag_name": "1.0.0", "description": "Amazing release. Wow!"}`)
})
mux.HandleFunc("/api/v4/projects/1/repository/tags/1.0.0/release",
func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "PUT")
fmt.Fprint(w, `{"tag_name": "1.0.0", "description": "Amazing release. Wow!"}`)
})
opt := &UpdateReleaseOptions{Description: String("Amazing release. Wow!")}
opt := &UpdateReleaseNoteOptions{Description: String("Amazing release. Wow!")}
release, _, err := client.Tags.UpdateRelease(1, "1.0.0", opt)
release, _, err := client.Tags.UpdateReleaseNote(1, "1.0.0", opt)
if err != nil {
t.Errorf("Tags.UpdateRelease returned error: %v", err)
}
want := &Release{TagName: "1.0.0", Description: "Amazing release. Wow!"}
want := &ReleaseNote{TagName: "1.0.0", Description: "Amazing release. Wow!"}
if !reflect.DeepEqual(want, release) {
t.Errorf("Tags.UpdateRelease returned %+v, want %+v", release, want)
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment