Skip to main content

Python script which is used to create releases on GitLab

Project description

Pipeline Status PyPI Project License PyPI Project Version Documentation Status

GitLab Auto Release

An example CI using this can be found here. This package was intended to be used by GitLab CI hence using environments provided by the GitLab CI. You can however use it as a CLI tool if you would like.

Usage

First you need to create a personal access token, more information here. With the scope api, so it can create the release for you.

pip install gitlab-auto-mr
gitlab_auto_release --help

Usage: gitlab_auto_release [OPTIONS]

  Gitlab Auto Release Tool.

Options:
  --private-token TEXT    Private GITLAB token, used to authenticate when
                          calling the MR API.  [required]
  --project-url TEXT      The project URL on GitLab to create the MR for.
                          [required]
  --project-id INTEGER    The project ID on GitLab to create the MR for.
                          [required]
  --tag-name TEXT         The tag the release should be created from.
                          [required]
  --release-name TEXT     The name of the release.  [required]
  -c, --changelog TEXT    Path to file to changelog file, will overwrite
                          description with tag matching changelog. Must be in
                          keepachangelog format.
  -d, --description TEXT  Path to file to use as the description for the MR.
  -a, --asset TEXT        An asset to include in the release, i.e.
                          name=link_to_asset.
  --link-artifacts        If set to true will link artifacts from current job.
  --help                  Show this message and exit.
gitlab_auto_release --private-token xxxx --project-id 8593636 \
  --project-url https://gitlab.com/stegappasaurus/stegappasaurus-app \
  --tag-name v0.1.0 --release-name v0.1.0 --link-artifacts false \
  --changelog CHANGELOG.md

GitLab CI

Set a secret variable in your GitLab project with your private token. Name it GITLAB_PRIVATE_TOKEN (CI/CD > Environment Variables). This is necessary to create the release on your behalf. More information click here. An example CI using this can be found here.

Add the following to your .gitlab-ci.yml file:

stages:
  - post

publish:release:
  image: registry.gitlab.com/gitlab-automation-toolkit/gitlab-auto-release
  stage: post
  only:
    - /^release/.*$/
  before_script: []
  variables:
    GIT_STRATEGY: none # We don't need to clone the project for this job
  script:
    - gitlab_auto_release --changelog CHANGELOG.md --link-assets

Changelog

You can find the changelog here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gitlab-auto-release, version 1.0.1
Filename, size & hash File type Python version Upload date
gitlab-auto-release-1.0.1.tar.gz (5.1 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page