From b82bdcccf09f230a6601bf4eec353ae4873c9fc8 Mon Sep 17 00:00:00 2001 From: Tamas Gal <tgal@km3net.de> Date: Sat, 10 Oct 2020 23:38:54 +0200 Subject: [PATCH] Update git stuff --- pages/Git.md | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/pages/Git.md b/pages/Git.md index 6d8b5a2..013b06c 100644 --- a/pages/Git.md +++ b/pages/Git.md @@ -1,5 +1,5 @@ --- -Title: Gitlab und Github +Title: Gitlab and Github Author: Tamas Title: - use for software, plots and analysis @@ -8,12 +8,28 @@ Title: status: dump --- -KM3NeT uses GitLab as the main platform to develop and discuss software, -analysis tools, papers and other private or collaborative creations. GitLab -offers professional and advanced features to keep track of development history -and allows a rich feature set to exchange thoughts and ideas around them. The -continuous integration (CI) that is part of the GitLab distribution proves to be -a powerful automation tool and is utilised to generate consistently up-to-date -test reports, documentation and software releases in a transparent way. +KM3NeT uses a self-hosted GitLab instance as the main platform to develop and +discuss software, analysis tools, papers and other private or collaborative +creations. GitLab offers professional and advanced features to keep track of +development history and its rich feature set allows to exchange and archive +thoughts and ideas easily. The continuous integration (CI) that is part of the +GitLab distribution, proves to be a powerful automation tool and is utilised to +generate consistently up-to-date test reports, documentation and software +releases in a transparent way. The CI pipeline is triggered every time when +changes are pushed to a project. Each job runs in an isolated Docker container +which makes them fully reproducible. -- docker +In case of test reports for example, failing tests are signalised in merge +requests and prevent changes that broke them to be applied accidentally. The +documentation is also built in a dedicated pipeline job and is published to the +web upon successful generation. A tight integration of the documentation into +the software projects is mandatory and highly improves its up-to-dateness. + +The KM3NeT GitLab server is accessible to the public but only projects which are +marked as _global_ are visible to a regular visitor without a KM3NeT account. +They can download the projects and all the public branches, access the issues, +documentation and Wiki, they however are not allowed to collaborate, i.e. to +comment or contribute in any way. To circumvent this problem, open source +projects are mirrored to a yet inofficial GitHub group +(https://github.com/KM3NeT) where everyone with a GitHub account is allowed to +interact. -- GitLab