Update a Release through Release-CLI
Release notes
In this milestone we have added the ability to update release directly from the release-cli. This can be used for automating releases by updating any of the release attributes directly from the .gitlab-ci.yml file and leveraging the CI/CD pipeline to do so.
Problem to solve
As a user of the release-cli, I wish to be able to perform all release activities directly from the .gitlab-ci.yml file.
This issue tackles Update release, which can then be parsed to obtain a specific field, like description.
Proposal
The release-cli is a simple HTTP client that makes API requests, it would be great to extend it to interact with the rest of the Release API endpoints.
Extend the release-cli to update a release.
PUT /projects/:id/releases/:tag_name
The user can update any of the following attributes:
| name | string | no | The release name. |
|---|---|---|---|
| description | string | no | The description of the release. You can use Markdown. |
| milestones | array of string | no | The title of each milestone to associate with the release. GitLab Premium customers can specify group milestones. To remove all milestones from the release, specify []. |
| released_at | datetime | no | The date when the release is/was ready. Expected in ISO 8601 format (2019-03-15T08:00:00Z). |
Implementation guide
DRAFT: demo for update release (!145 - closed) very roughly outlines the required changes.
Implementation Steps
-
Refactor: Use a common Release response struct - !148 (merged) -
Add command to update a Release - !147 (merged) -
Update docs - !150 (merged) -
Release a new version of release-cli- #160 (closed)
This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.