From 1d45d8409c30d5cc94636c4054d7e8f25c8a8096 Mon Sep 17 00:00:00 2001 From: Alejandro Lopez Gestoso <alopez@iri.upc.edu> Date: Wed, 7 Sep 2022 12:06:03 +0200 Subject: [PATCH] First update of Readme --- README.md | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4a4854f..a45d7f4 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,27 @@ -Gitlab-ci template: -´´´ - image: docker.io/labrobotica/labrobotica:latest - - variables: - GIT_SUBMODULE_STRATEGY: recursive - FROM_RDEPENDS_CI: "false" - TAG_VERSION: $CI_COMMIT_TAG - PACKAGE_NAME: "package_name" - - include: - remote: 'https://gitlab.iri.upc.edu/labrobotica/test/packaging_ci/-/raw/master/packaging-ci.yml' -´´´ +Packaging_ci {#mainpage} +================ + +## Description + +The pourpose of this package is to provide a gitlab Continuous Integration pipeline that automatically generates a package .deb file, upload it to our apt package server and trigger the same process to the packages that depends on it. That proccess is triggered when a new tag as version number (x.y.z) is generated. + +It also provides two [scripts](./scripts) that must be uploaded to the apt server in folder ~/repo_scripts. + +## Scripts + +#### update_repo script + +This script will be called from the gitlab CI jobs *update_repo_tag* and *update_repo_rdep*. It must be located at ~/repo_scripts folder in the package server. It will be executed in the package server. + +It has two arguments: + - The first argument is the name of the .deb file to be uploaded. Usually iri-<package_name>-dev. + - The second is the Ubuntu distribution. + +It tries to upload the .deb file for 10 times each 5 seconds. On success, it shows the list of packages on the server and deletes the .deb file. + +#### reverse_dependency script + +This script will be called from the gitlab CI job *modify_rdepends_ci*. It must be located at ~/repo_scripts folder in the package server. It will be executed in the docker. + +It has one argument: + - The target package name -- GitLab