diff --git a/readme.md b/readme.md index 7fb9fca..d07575b 100644 --- a/readme.md +++ b/readme.md @@ -80,6 +80,30 @@ Command: -f FILE_TO_BE_RELEASED -F RELEASE_INFO_FILE +### Use in CI script + +The PRIVATE_TOKEN should not be entered directly into the CI script but added as protected a CI variable to you particular project. + +Then add the following stage into your CI script: + + release: + stage: release + image: registry.gitlab.com/wolutator/base-build-env + tags: + - hottis + - linux + - docker + only: + - release + script: + - gitlabreleaseuploader.py -p $PRIVATE_TOKEN -i $CI_PROJECT_ID -u $CI_PROJECT_URL + -f gitlabreleaseuploader.py -F info.json -T $CI_COMMIT_REF_NAME + +Most information are taken from CI builtin variables, the tag name, release name and release description should be stored in +the info file, which is under version control. + +To avoid releasing a file with everything single push to an arbitrary branch, add the ``only`` block. +