gitlab-release

Tool to create gitlab revisions with file upload.Useful for CI publish tasks.

Forked

Forked from the upstream repo to:

Add a "Release Artifacts" to the release description
Stop the artifacts bulleted list from having two lines separation
Add curl in docker image (so, eg, posts to chat chanels can be made)
Update for latest Gitlab's changes to the Releases API.

Usage

This program is intended to be used in a GitLab CI job in a Runner with Docker.

1. Configure your `.gitlab-ci.yml`

To make an automatic release you need to add something like this to the file .gitlab-ci.yml in your project.

stages:
    - build
    - publish
build:
    stage: build
    script:
        - my_build_command
    artifacts:
        expire_in: '1 hour'
        paths:
            - compiled-$CI_BUILD_TAG.exe
            - doc-$CI_BUILD_TAG.pdf
publish:
    image: inetprocess/gitlab-release
    stage: publish
    only:
        - tags
    script:
        - gitlab-release --message 'My release message' compiled-$CI_BUILD_TAG.exe doc-$CI_BUILD_TAG.pdf

2. Generate a personnal access token

Generate a new Personal Access Token from your user profile with the api scope.

3. Configure your project

Set a secret variable in your project named GITLAB_ACCESS_TOKEN with the token you have generated in the previous step.

Testing locally

Set the following environemnt variables:

CI_SERVER_VERSION=9.0.0
CI_PROJECT_URL=https://gitlab.com
CI_PROJECT_ID=xxxxxxx                       # Get it from the Gitlab site
GITLAB_ACCESS_TOKEN=xXxXxXxXxXxXxXxXxXxX    # Must be a valid Personal Access Token
CI_COMMIT_TAG=1.0.1                         # Tag must ALREADY exist in the repo
                                            # as the script does NOT created it!

and run the script:

python gitlab-release --message "some message"

sue445/gitlab-release