Skip to content

GitLab Next

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
R
release-cli
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 22
    • Issues 22
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge Requests 1
    • Merge Requests 1
  • Requirements
    • Requirements
    • List
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Security & Compliance
    • Security & Compliance
    • Dependency List
    • License Compliance
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Code Review
    • Insights
    • Issue
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • GitLab.org
  • release-cli
  • Merge Requests
  • !67

Merged
Opened Oct 29, 2020 by Nejc Habjan@nejch1Guest

Read release description from file if present

  • Overview 105
  • Commits 18
  • Pipelines 18
  • Changes 12

Allows specifying a file inside the current working directory ($CI_PROJECT_DIR) to read for the release description, either via the release-cli tool or in .gitlab-ci.yml in the release:description: node.

Usage in .gitlab-ci.yml:

release:
  stage: release
  script: echo "Creating new release"
  release:
    tag: v1.0.0
    name: "Release v1.0.0"
    description: description.txt

Usage in CLI:

release-cli create --name "Release v1.0.0" --description "description.txt" --tag-name "v1.0.0" ...

This has the following behavior:

  • if the description contains spaces between words: it is treated as a string,
  • if the description is a single word and is a file or a symlink to a file inside $CI_PROJECT_DIR: the file's contents will be read as the release description,
  • if the description is a single word and is a file or a symlink to a file outside $CI_PROJECT_DIR, or if the target file does not exist: it is treated as a string.

Closes #14 (closed).

Edited Dec 15, 2020 by Jaime Martinez
Assignee
Assign to
Reviewer
Request review from
13.7
Milestone
13.7 (Past due)
Assign milestone
Time tracking
Reference: gitlab-org/release-cli!67
Source branch: read-release-description-from-file

Revert this merge request

This will create a new commit in order to revert the existing changes.

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.

Cherry-pick this merge request

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.