Add `ref`, `milestones` and `released_at` to releaser-cli and yml
Problem to solve
Currently there are some decrepencies between the :release
yaml, the capabilities of the REST API and the releaser-cli
, when creating a release.
REST API | release yaml | releaser-cli |
---|---|---|
ref |
No | Yes |
milestones |
No | No |
released_at |
No | No |
Please note, this issue does not address release assets or binary assets, as they are being separately handled.
The :release
yaml needs to have these items added:
ref
milestones
released_at
The releaser-cli
needs to have these item added, and this is covered here:
milestones
released_at
No Runner changes will be needed to complete this issue.
Example yaml with the additional nodes:
release_job:
stage: 'release'
only: 'tags'
script:
- echo 'running release_job'
release:
name: 'Release $CI_COMMIT_SHA'
description: 'Created using the release-cli $EXTRA_DESCRIPTION'
tag_name: 'release-$CI_COMMIT_SHA'
ref: '$CI_COMMIT_SHA'
milestones:
- 'm1'
- 'm2'
- 'm3'
released_at: '2020-07-15T08:00:00Z'
Example script for the releaser-cli
:
release-cli create --name "Release $CI_COMMIT_SHA" --description "Created using the release-cli $EXTRA_DESCRIPTION" --tag-name "release-$CI_COMMIT_SHA" --ref "$CI_COMMIT_SHA" --released-at "2020-07-15T08:00:00Z" --milestone "m1" --milestone "m2" --milestone "m3"
Intended users
User experience goal
Proposal
Further details
Permissions and Security
Documentation
Availability & Testing
What does success look like, and how can we measure that?
What is the type of buyer?
Is this a cross-stage feature?
Links / references
Edited by Sean Carroll