13 Commits
v1.6 ... v1.9

6 changed files with 118 additions and 29 deletions

View File

@ -23,6 +23,7 @@ release:
only: only:
- release - release
script: script:
- zip GitlabReleaseTool.zip gitlabreleaseuploader.py deleterelease.py
- python gitlabreleaseuploader.py -p $PRIVATE_TOKEN -i $CI_PROJECT_ID -u $CI_PROJECT_URL - python gitlabreleaseuploader.py -p $PRIVATE_TOKEN -i $CI_PROJECT_ID -u $CI_PROJECT_URL
-f gitlabreleaseuploader.py -F info.json -T $CI_COMMIT_REF_NAME -f GitlabReleaseTool.zip -F info.json -T $CI_COMMIT_REF_NAME

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2019 Wolfgang Hottgenroth
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

56
deleterelease.py Normal file
View File

@ -0,0 +1,56 @@
#!/usr/bin/python
import requests
import json
import argparse
import sys
parser = argparse.ArgumentParser(description='Gitlab Release Deleter')
parser.add_argument('--privateToken', '-p',
help='Private token to access Gitlab', required=True)
parser.add_argument('--projectId', '-i',
help='ProjectID of the related project', required=True)
parser.add_argument('--releaseTag', '-t',
help='Tag of the release in the repo',
required=True,
default='')
parser.add_argument('--instanceUrl', '-I',
help='URL of your gitlab instance', required=False,
default='https://gitlab.com')
parser.add_argument('--verbose', '-v',
help='verbose output',
required=False,
action='store_true',
default=False)
parser.add_argument('--caBundle', '-B',
help='File with the CA certificates to trust', required=False,
default='/etc/ssl/certs/ca-certificates.crt')
args = parser.parse_args()
privateToken = args.privateToken
projectId = args.projectId
releaseTag = args.releaseTag
instanceUrl = args.instanceUrl
verbose = args.verbose
caBundle = args.caBundle
# --- delete release
deleteReleaseUrl = "%s/api/v4/projects/%s/releases/%s" % (instanceUrl, projectId, releaseTag)
headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
if verbose:
print("URL: %s" % deleteReleaseUrl)
deleteReleaseResult = requests.delete(deleteReleaseUrl, headers=headers, verify=caBundle)
if deleteReleaseResult.status_code != 200:
print(deleteReleaseResult)
print(deleteReleaseResult.text)
raise Exception('Unable to delete release')
if verbose:
print(deleteReleaseResult)
print(deleteReleaseResult.text)
print('Release successfully delete')

View File

@ -14,7 +14,9 @@ parser.add_argument('--projectId', '-i',
parser.add_argument('--projectUrl', '-u', parser.add_argument('--projectUrl', '-u',
help='URL of the related project at Gitlab', required=True) help='URL of the related project at Gitlab', required=True)
parser.add_argument('--file', '-f', parser.add_argument('--file', '-f',
help='File to be released', required=True) help='File to be released, can appear multiple times',
action='append',
required=True)
parser.add_argument('--releaseName', '-n', parser.add_argument('--releaseName', '-n',
help='Name of the release', required=False, help='Name of the release', required=False,
default='') default='')
@ -42,6 +44,9 @@ parser.add_argument('--releaseInfoFile', '-F',
parser.add_argument('--instanceUrl', '-I', parser.add_argument('--instanceUrl', '-I',
help='URL of your gitlab instance', required=False, help='URL of your gitlab instance', required=False,
default='https://gitlab.com') default='https://gitlab.com')
parser.add_argument('--caBundle', '-B',
help='File with the CA certificates to trust', required=False,
default='/etc/ssl/certs/ca-certificates.crt')
parser.add_argument('--verbose', '-v', parser.add_argument('--verbose', '-v',
help='verbose output', help='verbose output',
required=False, required=False,
@ -52,7 +57,7 @@ args = parser.parse_args()
privateToken = args.privateToken privateToken = args.privateToken
projectId = args.projectId projectId = args.projectId
projectUrl = args.projectUrl projectUrl = args.projectUrl
fileToUpload = args.file filesToUpload = args.file
releaseName = args.releaseName releaseName = args.releaseName
releaseTag = args.releaseTag releaseTag = args.releaseTag
releaseTagTarget = args.releaseTagTarget releaseTagTarget = args.releaseTagTarget
@ -60,6 +65,7 @@ releaseDescription = args.description
instanceUrl = args.instanceUrl instanceUrl = args.instanceUrl
createReleaseTag = args.createReleaseTag createReleaseTag = args.createReleaseTag
releaseInfoFilename = args.releaseInfoFile releaseInfoFilename = args.releaseInfoFile
caBundle = args.caBundle
verbose = args.verbose verbose = args.verbose
releaseInfo = {} releaseInfo = {}
@ -92,21 +98,26 @@ if releaseDescription == '':
# --- upload the file # --- upload the file
uploadUrl = "%s/api/v4/projects/%s/uploads" % (instanceUrl, projectId) uploadUrl = "%s/api/v4/projects/%s/uploads" % (instanceUrl, projectId)
headers = {"PRIVATE-TOKEN": privateToken} headers = {"PRIVATE-TOKEN": privateToken}
files = {"file": open(fileToUpload, 'rb')}
uploadResult = requests.post(uploadUrl, files=files, headers=headers) assets = []
for filename in filesToUpload:
with open(filename, 'rb') as filehandle:
files = {"file": filehandle}
if uploadResult.status_code != 201: uploadResult = requests.post(uploadUrl, files=files, headers=headers, verify=caBundle)
if uploadResult.status_code != 201:
print(uploadResult) print(uploadResult)
print(uploadResult.text) print(uploadResult.text)
raise Exception('Unable to upload file to Gitlab') raise Exception('Unable to upload file to Gitlab')
if verbose: if verbose:
print(uploadResult) print(uploadResult)
print(uploadResult.text) print(uploadResult.text)
print('File successfully uploaded') print('File {} successfully uploaded'.format(filename))
uploadResultJson = json.loads(uploadResult.text) url = projectUrl + json.loads(uploadResult.text)['url']
assets.append({'name': filename, 'url': url})
# --- create release tag # --- create release tag
if createReleaseTag: if createReleaseTag:
@ -124,7 +135,8 @@ if createReleaseTag:
createReleaseTagResult = requests.post(createReleaseTagUrl, createReleaseTagResult = requests.post(createReleaseTagUrl,
headers=headers, headers=headers,
data=json.dumps(payloadCreateReleaseTag)) data=json.dumps(payloadCreateReleaseTag),
verify=caBundle)
if createReleaseTagResult.status_code != 201: if createReleaseTagResult.status_code != 201:
print(createReleaseTagResult) print(createReleaseTagResult)
@ -140,24 +152,19 @@ if createReleaseTag:
# --- create release # --- create release
createReleaseUrl = "%s/api/v4/projects/%s/releases" % (instanceUrl, projectId) createReleaseUrl = "%s/api/v4/projects/%s/releases" % (instanceUrl, projectId)
headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"} headers = {"PRIVATE-TOKEN": privateToken, "Content-Type": "application/json"}
fullUrl = projectUrl + uploadResultJson['url']
payloadCreateRelease = { payloadCreateRelease = {
"name": releaseName, "name": releaseName,
"tag_name": releaseTag, "tag_name": releaseTag,
"description": releaseDescription, "description": releaseDescription,
"assets": { "assets": {
"links": [ "links": assets
{
"name": fileToUpload,
"url": fullUrl
}
]
} }
} }
createReleaseResult = requests.post(createReleaseUrl, headers=headers, createReleaseResult = requests.post(createReleaseUrl, headers=headers,
data=json.dumps(payloadCreateRelease)) data=json.dumps(payloadCreateRelease),
verify=caBundle)
if createReleaseResult.status_code != 201: if createReleaseResult.status_code != 201:
print(createReleaseResult) print(createReleaseResult)

View File

@ -1,7 +1,7 @@
{ {
"releaseTag": "v1.6", "releaseTag": "v1.9",
"createReleaseTag": "true", "createReleaseTag": "true",
"releaseName": "Seventh release of the uploader", "releaseName": "use with statement",
"description": "Work on readme and change of CI script" "description": "perform file upload using with statement"
} }

View File

@ -21,6 +21,7 @@ Gitlab CI scripts.
[--createReleaseTag] [--createReleaseTag]
[--description DESCRIPTION] [--description DESCRIPTION]
[--releaseInfoFile RELEASEINFOFILE] [--releaseInfoFile RELEASEINFOFILE]
[--caBundle FILE_WITH_CA_CERTIFICATES_TO_TRUST]
[--instanceUrl INSTANCEURL] [--verbose] [--instanceUrl INSTANCEURL] [--verbose]
Gitlab Release Uploader Gitlab Release Uploader
@ -49,6 +50,7 @@ Gitlab CI scripts.
tag, create release tag, description tag, create release tag, description
--instanceUrl INSTANCEURL, -I INSTANCEURL --instanceUrl INSTANCEURL, -I INSTANCEURL
URL of your gitlab instance URL of your gitlab instance
--caBundle FILE_WITH_CA_CERTIFICATES_TO_TRUST, -B FILE_WITH_CA_CERTIFICATES_TO_TRUST
--verbose, -v verbose output --verbose, -v verbose output
wn@tron:~/workspace-python/gitlabreleaseuploader [master ≡]$ wn@tron:~/workspace-python/gitlabreleaseuploader [master ≡]$
@ -71,7 +73,7 @@ Release Info File:
"releaseTag": "v1.5", "releaseTag": "v1.5",
"createReleaseTag": "true", "createReleaseTag": "true",
"releaseName": "Sixth release of the uploader", "releaseName": "Sixth release of the uploader",
"description": "Now with CI script and automatic release upload (he, eat your own dogfood)" "description": "Now with CI script and automatic release upload (hey, eat your own dogfood)"
} }
Command: Command:
@ -95,9 +97,11 @@ Then add the following stage into your CI script:
- gitlabreleaseuploader.py -p $PRIVATE_TOKEN -i $CI_PROJECT_ID -u $CI_PROJECT_URL - gitlabreleaseuploader.py -p $PRIVATE_TOKEN -i $CI_PROJECT_ID -u $CI_PROJECT_URL
-f gitlabreleaseuploader.py -F info.json -T $CI_COMMIT_REF_NAME -f gitlabreleaseuploader.py -F info.json -T $CI_COMMIT_REF_NAME
(Note, please: this stage definition is for a docker worker. It uses my ``base-build-env`` image, which already contains the Note, please: this stage definition is for a docker worker. It uses my ``base-build-env`` image, which already contains the
uploader script. However, it is no problem to use the uploader script also in different environments. It just depends on the uploader script. However, it is no problem to use the uploader script also in different environments. It just depends on the
``Requests`` package.) ``Requests`` package.
Note too, please: this job is releasing the ``gitlabreleaseuploader.py`` script itself, so you see the name of the script twice in the CI script. Don't be confused, the option ``-f`` gets the file to be released.
Most information are taken from CI builtin variables, the tag name, release name and release description should be stored in Most information are taken from CI builtin variables, the tag name, release name and release description should be stored in
the release info file (here: ``info.json``), which is under version control. the release info file (here: ``info.json``), which is under version control.