release-cli: Path to v1.0.0
This issue will list the requirements needed to release a stable version of the release-cli v1.0.0.
As of 2021-10-01, the release-cli is capable of:
- Getting a release by tag name
- Creating a release with different attributes (name, description, tag_name, ref, milestones, assets, released_at) that match the Releases API
- The
release-cliis the tool behind thereleasekeyword in.gitlab-ci.ymlfile since %13.2 - We track the usage from the API for GitLab.com since %13.12, see the dashboard
- Most reported bugs have been closed
- We dogfood the
releasekeyword and the generic package registry
The big question is whether we need to support all the API endpoints as stated in &5216 before we tag v1.0.0
Relevant issues before v1.0.0
| Issue | Must-have | Notes |
|---|---|---|
| Improved usage documentation #120 and #111 | ||
| Update/Add CONTRIBUTING.md #32 (closed) | ||
| Automate versioning #129 | ||
Add --debug capabilities #70 (closed)
|
||
| Remove deprecated flags #49 (closed) | ||
| Allow paths inside $CI_BUILDS_DIR for custom CA certificates #104 (closed) | ||
| Support other API endpoints, such as editing a release | see big epic &5216 | |
| Stop deploying binaries to S3 #116 (closed) | ||
| Support x509 auth #85 | ||
| Create annotated tags #62 (closed) | depends on adding the functionality to the API (I think) | |
| Read parameters from file #50 (closed) | Nice-to-have | |
| Generate description from recently closed gitlab issues #106 | Nice-to-have | |
| Generate description from a subsection of a changelog #81 | Nice-to-have | |
| Automate changelog generation #79 | Nice-to-have |
Edited by Jaime Martinez
