repos_releases.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  1. // Copyright 2013 The go-github AUTHORS. All rights reserved.
  2. //
  3. // Use of this source code is governed by a BSD-style
  4. // license that can be found in the LICENSE file.
  5. package github
  6. import (
  7. "context"
  8. "errors"
  9. "fmt"
  10. "io"
  11. "mime"
  12. "net/http"
  13. "os"
  14. "path/filepath"
  15. "strings"
  16. )
  17. // RepositoryRelease represents a GitHub release in a repository.
  18. type RepositoryRelease struct {
  19. ID *int64 `json:"id,omitempty"`
  20. TagName *string `json:"tag_name,omitempty"`
  21. TargetCommitish *string `json:"target_commitish,omitempty"`
  22. Name *string `json:"name,omitempty"`
  23. Body *string `json:"body,omitempty"`
  24. Draft *bool `json:"draft,omitempty"`
  25. Prerelease *bool `json:"prerelease,omitempty"`
  26. CreatedAt *Timestamp `json:"created_at,omitempty"`
  27. PublishedAt *Timestamp `json:"published_at,omitempty"`
  28. URL *string `json:"url,omitempty"`
  29. HTMLURL *string `json:"html_url,omitempty"`
  30. AssetsURL *string `json:"assets_url,omitempty"`
  31. Assets []ReleaseAsset `json:"assets,omitempty"`
  32. UploadURL *string `json:"upload_url,omitempty"`
  33. ZipballURL *string `json:"zipball_url,omitempty"`
  34. TarballURL *string `json:"tarball_url,omitempty"`
  35. Author *User `json:"author,omitempty"`
  36. }
  37. func (r RepositoryRelease) String() string {
  38. return Stringify(r)
  39. }
  40. // ReleaseAsset represents a GitHub release asset in a repository.
  41. type ReleaseAsset struct {
  42. ID *int64 `json:"id,omitempty"`
  43. URL *string `json:"url,omitempty"`
  44. Name *string `json:"name,omitempty"`
  45. Label *string `json:"label,omitempty"`
  46. State *string `json:"state,omitempty"`
  47. ContentType *string `json:"content_type,omitempty"`
  48. Size *int `json:"size,omitempty"`
  49. DownloadCount *int `json:"download_count,omitempty"`
  50. CreatedAt *Timestamp `json:"created_at,omitempty"`
  51. UpdatedAt *Timestamp `json:"updated_at,omitempty"`
  52. BrowserDownloadURL *string `json:"browser_download_url,omitempty"`
  53. Uploader *User `json:"uploader,omitempty"`
  54. }
  55. func (r ReleaseAsset) String() string {
  56. return Stringify(r)
  57. }
  58. // ListReleases lists the releases for a repository.
  59. //
  60. // GitHub API docs: https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository
  61. func (s *RepositoriesService) ListReleases(ctx context.Context, owner, repo string, opt *ListOptions) ([]*RepositoryRelease, *Response, error) {
  62. u := fmt.Sprintf("repos/%s/%s/releases", owner, repo)
  63. u, err := addOptions(u, opt)
  64. if err != nil {
  65. return nil, nil, err
  66. }
  67. req, err := s.client.NewRequest("GET", u, nil)
  68. if err != nil {
  69. return nil, nil, err
  70. }
  71. var releases []*RepositoryRelease
  72. resp, err := s.client.Do(ctx, req, &releases)
  73. if err != nil {
  74. return nil, resp, err
  75. }
  76. return releases, resp, nil
  77. }
  78. // GetRelease fetches a single release.
  79. //
  80. // GitHub API docs: https://developer.github.com/v3/repos/releases/#get-a-single-release
  81. func (s *RepositoriesService) GetRelease(ctx context.Context, owner, repo string, id int64) (*RepositoryRelease, *Response, error) {
  82. u := fmt.Sprintf("repos/%s/%s/releases/%d", owner, repo, id)
  83. return s.getSingleRelease(ctx, u)
  84. }
  85. // GetLatestRelease fetches the latest published release for the repository.
  86. //
  87. // GitHub API docs: https://developer.github.com/v3/repos/releases/#get-the-latest-release
  88. func (s *RepositoriesService) GetLatestRelease(ctx context.Context, owner, repo string) (*RepositoryRelease, *Response, error) {
  89. u := fmt.Sprintf("repos/%s/%s/releases/latest", owner, repo)
  90. return s.getSingleRelease(ctx, u)
  91. }
  92. // GetReleaseByTag fetches a release with the specified tag.
  93. //
  94. // GitHub API docs: https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name
  95. func (s *RepositoriesService) GetReleaseByTag(ctx context.Context, owner, repo, tag string) (*RepositoryRelease, *Response, error) {
  96. u := fmt.Sprintf("repos/%s/%s/releases/tags/%s", owner, repo, tag)
  97. return s.getSingleRelease(ctx, u)
  98. }
  99. func (s *RepositoriesService) getSingleRelease(ctx context.Context, url string) (*RepositoryRelease, *Response, error) {
  100. req, err := s.client.NewRequest("GET", url, nil)
  101. if err != nil {
  102. return nil, nil, err
  103. }
  104. release := new(RepositoryRelease)
  105. resp, err := s.client.Do(ctx, req, release)
  106. if err != nil {
  107. return nil, resp, err
  108. }
  109. return release, resp, nil
  110. }
  111. // CreateRelease adds a new release for a repository.
  112. //
  113. // GitHub API docs: https://developer.github.com/v3/repos/releases/#create-a-release
  114. func (s *RepositoriesService) CreateRelease(ctx context.Context, owner, repo string, release *RepositoryRelease) (*RepositoryRelease, *Response, error) {
  115. u := fmt.Sprintf("repos/%s/%s/releases", owner, repo)
  116. req, err := s.client.NewRequest("POST", u, release)
  117. if err != nil {
  118. return nil, nil, err
  119. }
  120. r := new(RepositoryRelease)
  121. resp, err := s.client.Do(ctx, req, r)
  122. if err != nil {
  123. return nil, resp, err
  124. }
  125. return r, resp, nil
  126. }
  127. // EditRelease edits a repository release.
  128. //
  129. // GitHub API docs: https://developer.github.com/v3/repos/releases/#edit-a-release
  130. func (s *RepositoriesService) EditRelease(ctx context.Context, owner, repo string, id int64, release *RepositoryRelease) (*RepositoryRelease, *Response, error) {
  131. u := fmt.Sprintf("repos/%s/%s/releases/%d", owner, repo, id)
  132. req, err := s.client.NewRequest("PATCH", u, release)
  133. if err != nil {
  134. return nil, nil, err
  135. }
  136. r := new(RepositoryRelease)
  137. resp, err := s.client.Do(ctx, req, r)
  138. if err != nil {
  139. return nil, resp, err
  140. }
  141. return r, resp, nil
  142. }
  143. // DeleteRelease delete a single release from a repository.
  144. //
  145. // GitHub API docs: https://developer.github.com/v3/repos/releases/#delete-a-release
  146. func (s *RepositoriesService) DeleteRelease(ctx context.Context, owner, repo string, id int64) (*Response, error) {
  147. u := fmt.Sprintf("repos/%s/%s/releases/%d", owner, repo, id)
  148. req, err := s.client.NewRequest("DELETE", u, nil)
  149. if err != nil {
  150. return nil, err
  151. }
  152. return s.client.Do(ctx, req, nil)
  153. }
  154. // ListReleaseAssets lists the release's assets.
  155. //
  156. // GitHub API docs: https://developer.github.com/v3/repos/releases/#list-assets-for-a-release
  157. func (s *RepositoriesService) ListReleaseAssets(ctx context.Context, owner, repo string, id int64, opt *ListOptions) ([]*ReleaseAsset, *Response, error) {
  158. u := fmt.Sprintf("repos/%s/%s/releases/%d/assets", owner, repo, id)
  159. u, err := addOptions(u, opt)
  160. if err != nil {
  161. return nil, nil, err
  162. }
  163. req, err := s.client.NewRequest("GET", u, nil)
  164. if err != nil {
  165. return nil, nil, err
  166. }
  167. var assets []*ReleaseAsset
  168. resp, err := s.client.Do(ctx, req, &assets)
  169. if err != nil {
  170. return nil, resp, err
  171. }
  172. return assets, resp, nil
  173. }
  174. // GetReleaseAsset fetches a single release asset.
  175. //
  176. // GitHub API docs: https://developer.github.com/v3/repos/releases/#get-a-single-release-asset
  177. func (s *RepositoriesService) GetReleaseAsset(ctx context.Context, owner, repo string, id int64) (*ReleaseAsset, *Response, error) {
  178. u := fmt.Sprintf("repos/%s/%s/releases/assets/%d", owner, repo, id)
  179. req, err := s.client.NewRequest("GET", u, nil)
  180. if err != nil {
  181. return nil, nil, err
  182. }
  183. asset := new(ReleaseAsset)
  184. resp, err := s.client.Do(ctx, req, asset)
  185. if err != nil {
  186. return nil, resp, err
  187. }
  188. return asset, resp, nil
  189. }
  190. // DownloadReleaseAsset downloads a release asset or returns a redirect URL.
  191. //
  192. // DownloadReleaseAsset returns an io.ReadCloser that reads the contents of the
  193. // specified release asset. It is the caller's responsibility to close the ReadCloser.
  194. // If a redirect is returned, the redirect URL will be returned as a string instead
  195. // of the io.ReadCloser. Exactly one of rc and redirectURL will be zero.
  196. //
  197. // GitHub API docs: https://developer.github.com/v3/repos/releases/#get-a-single-release-asset
  198. func (s *RepositoriesService) DownloadReleaseAsset(ctx context.Context, owner, repo string, id int64) (rc io.ReadCloser, redirectURL string, err error) {
  199. u := fmt.Sprintf("repos/%s/%s/releases/assets/%d", owner, repo, id)
  200. req, err := s.client.NewRequest("GET", u, nil)
  201. if err != nil {
  202. return nil, "", err
  203. }
  204. req.Header.Set("Accept", defaultMediaType)
  205. s.client.clientMu.Lock()
  206. defer s.client.clientMu.Unlock()
  207. var loc string
  208. saveRedirect := s.client.client.CheckRedirect
  209. s.client.client.CheckRedirect = func(req *http.Request, via []*http.Request) error {
  210. loc = req.URL.String()
  211. return errors.New("disable redirect")
  212. }
  213. defer func() { s.client.client.CheckRedirect = saveRedirect }()
  214. req = withContext(ctx, req)
  215. resp, err := s.client.client.Do(req)
  216. if err != nil {
  217. if !strings.Contains(err.Error(), "disable redirect") {
  218. return nil, "", err
  219. }
  220. return nil, loc, nil // Intentionally return no error with valid redirect URL.
  221. }
  222. if err := CheckResponse(resp); err != nil {
  223. resp.Body.Close()
  224. return nil, "", err
  225. }
  226. return resp.Body, "", nil
  227. }
  228. // EditReleaseAsset edits a repository release asset.
  229. //
  230. // GitHub API docs: https://developer.github.com/v3/repos/releases/#edit-a-release-asset
  231. func (s *RepositoriesService) EditReleaseAsset(ctx context.Context, owner, repo string, id int64, release *ReleaseAsset) (*ReleaseAsset, *Response, error) {
  232. u := fmt.Sprintf("repos/%s/%s/releases/assets/%d", owner, repo, id)
  233. req, err := s.client.NewRequest("PATCH", u, release)
  234. if err != nil {
  235. return nil, nil, err
  236. }
  237. asset := new(ReleaseAsset)
  238. resp, err := s.client.Do(ctx, req, asset)
  239. if err != nil {
  240. return nil, resp, err
  241. }
  242. return asset, resp, nil
  243. }
  244. // DeleteReleaseAsset delete a single release asset from a repository.
  245. //
  246. // GitHub API docs: https://developer.github.com/v3/repos/releases/#delete-a-release-asset
  247. func (s *RepositoriesService) DeleteReleaseAsset(ctx context.Context, owner, repo string, id int64) (*Response, error) {
  248. u := fmt.Sprintf("repos/%s/%s/releases/assets/%d", owner, repo, id)
  249. req, err := s.client.NewRequest("DELETE", u, nil)
  250. if err != nil {
  251. return nil, err
  252. }
  253. return s.client.Do(ctx, req, nil)
  254. }
  255. // UploadReleaseAsset creates an asset by uploading a file into a release repository.
  256. // To upload assets that cannot be represented by an os.File, call NewUploadRequest directly.
  257. //
  258. // GitHub API docs: https://developer.github.com/v3/repos/releases/#upload-a-release-asset
  259. func (s *RepositoriesService) UploadReleaseAsset(ctx context.Context, owner, repo string, id int64, opt *UploadOptions, file *os.File) (*ReleaseAsset, *Response, error) {
  260. u := fmt.Sprintf("repos/%s/%s/releases/%d/assets", owner, repo, id)
  261. u, err := addOptions(u, opt)
  262. if err != nil {
  263. return nil, nil, err
  264. }
  265. stat, err := file.Stat()
  266. if err != nil {
  267. return nil, nil, err
  268. }
  269. if stat.IsDir() {
  270. return nil, nil, errors.New("the asset to upload can't be a directory")
  271. }
  272. mediaType := mime.TypeByExtension(filepath.Ext(file.Name()))
  273. req, err := s.client.NewUploadRequest(u, file, stat.Size(), mediaType)
  274. if err != nil {
  275. return nil, nil, err
  276. }
  277. asset := new(ReleaseAsset)
  278. resp, err := s.client.Do(ctx, req, asset)
  279. if err != nil {
  280. return nil, resp, err
  281. }
  282. return asset, resp, nil
  283. }