CNB

Publish Release

git:release

Git Release

# Applicable Events

  • push
  • branch.create
  • tag_push
  • pull_request.merged
  • api_trigger
  • web_trigger
  • tag_deploy

# Parameters

# overlying

  • type: Boolean
  • required: false
  • default: false

Overlay mode

  • true：Overlay mode allows multiple submissions of the same release, and the final release is the union of all the submissions. If an attachment with the same name already exists, it will be deleted before uploading, achieving an update effect.
  • false：Non-overlay mode takes only the last submission into account, discarding any previous submissions.

Tip

By default, when a release version already exists, it will be deleted first and then regenerated.

# name

  • type: String
  • required: false

The name of the release.

For non tag_push events, it is necessary to provide the name of the tag to determine the Tag name.

For tag_push events, the current Tag name is automatically taken.

# title

  • type: String
  • required: false
  • default: ``Tag name

The title of the release.

# description

  • type: String
  • required: false

The description of the release.

# preRelease

  • type: Boolean
  • required: false
  • default: false

Whether to set the release as a "pre-release".

# Output Results

None

# Configuration Examples

# Generate Changelog and Automatically Update Release Description

$:
  tag_push:
    - stages:
        - name: changelog
          image: cnbcool/changelog
          exports:
            latestChangeLog: LATEST_CHANGE_LOG
        - name: upload release
          type: git:release
          options:
            title: release
            description: ${LATEST_CHANGE_LOG}

# Push

main:
  push:
    - stages:
        - name: git release
          type: git:release
          options:
            name: Nightly
            description: description

← coverage →