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]

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]
  --changelog TEXT       Path to file to changelog file, will overwrite
                        description with tag matching changelog. Must be in
                        keepachangelog format.
  --description TEXT     Path to file to use as the description for the MR.
  --asset TEXT           An asset to include in the release, i.e.
                        name=link_to_asset.
  --link-artifacts TEXT  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: []
  script:
    - gitlab_auto_release

You can set extra variables like so.

variables:
  CHANGELOG: CHANGELOG.md
  DESCRIPTION: "This is my release"
  • CHANGELOG: Changelog file to use in the description for the release.

  • DESCRIPTION: The description to include in the release.

  • LINK_ARTIFACTS: If set to True (default to True) will include artifacts from the current CI job.

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.

Source Distribution

gitlab-auto-release-0.2.1.tar.gz (5.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page