osmith has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-ci/+/35264?usp=email )
Change subject: README: update and convert to markdown ...................................................................... README: update and convert to markdown * Describe all directories * Update the text slightly * Convert to markdown, so it shows up formatted at: https://gitea.osmocom.org/osmocom/osmo-ci Change-Id: I9735eb30cf7260d211d5ea4da83ad09d31c93593 --- D README.adoc A README.md 2 files changed, 62 insertions(+), 30 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-ci refs/changes/64/35264/1 diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 23d723b..0000000 --- a/README.adoc +++ /dev/null @@ -1,30 +0,0 @@ -Scripts used for the CI handling and coverity uploads - -coverity: scripts used to submit the osmocom sources for coverity scan. -This depends on these, which are not included in osmo-ci: -- a tokens.txt file in coverity/ -- see coverity/get_token.sh -- a cov-analysis-linux64-8.5.0 in coverity/ - (or the like, may need to adjust some scripts to match) - -jobs: Jenkins Job Builder YAML files defining jenkins jobs. Read jobs/README.adoc -for more information about deployment. - -scripts: used by jenkins jobs. Various osmo*/contrib/jenkins.sh scripts assume -osmo-ci to be checked out in the build slave user's home, i.e. using a PATH of -$HOME/osmo-ci/scripts. - -obs-patches: patches to build projects for various debian distributions, e.g. -a patch for limesuite that fixes the libwxgtk3.0-dev => libwxgtk3.0-gtk3-dev -rename in control/debian for debian10. Used by osmo_obs_distro_specific_patch() -in scripts/common-obs.sh. - -_docker_playground: Clone of docker-playground.git, so the scripts can build -required docker images. This dir gets created on demand by scripts/common.sh, -and automatically fetched and reset to "origin/master" (override with -$OSMO_BRANCH_DOCKER_PLAYGROUND). The fetch and reset gets skipped if -_docker_playground is a symlink. For development, set it up as follows: - - $ git clone https://gitea.osmocom.org/osmocom/docker-playground - $ git clone https://gitea.osmocom.org/osmocom/osmo-ci - $ cd osmo-ci - $ ln -s ../docker-playground _docker_playground diff --git a/README.md b/README.md new file mode 100644 index 0000000..c8d4af4 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# Osmocom CI and infrastructure files + +## ansible +Ansible rules for setting up machines of the Osmocom infrastructure. +See `ansible/README.md`. + +## contrib +Scripts and files that did not fit into other directories. + +## coverity +Scripts used to submit the osmocom sources for coverity scan. +This depends on these, which are not included in osmo-ci: +- a tokens.txt file in coverity/ -- see coverity/get_token.sh +- a cov-analysis-linux64-8.5.0 in coverity/ + (or the like, may need to adjust some scripts to match) + +## jobs +Jenkins Job Builder YAML files defining jenkins jobs. Read `jobs/README.adoc` +for more information about deployment. + +## lint +The linter running on patches submitted via gerrit. See the wiki page +[Linting](https://osmocom.org/projects/cellular-infrastructure/wiki/Linting) +for more information. + +## qemu-kvm +A script to create a virtual machine with kernel gtp ggsn for qemu-kvm. + +## scripts +Scripts used by jenkins jobs. Various `osmo*/contrib/jenkins.sh` scripts assume +osmo-ci to be checked out in the build slave user's home, i.e. using a PATH of +`$HOME/osmo-ci/scripts`. + +## _docker_playground +A clone of +[docker-playground](https://gitea.osmocom.org/osmocom/docker-playgroundhttps://gitea.osmocom.org/osmocom/docker-playground), +so the scripts can build required docker images. This dir gets created on +demand by scripts/common.sh, and automatically fetched and reset to +"origin/master" (override with `$OSMO_BRANCH_DOCKER_PLAYGROUND`). The fetch and +reset gets skipped if _docker_playground is a symlink. For development, set it +up as follows: + +``` +$ git clone https://gitea.osmocom.org/osmocom/docker-playground +$ git clone https://gitea.osmocom.org/osmocom/osmo-ci +$ cd osmo-ci +$ ln -s ../docker-playground _docker_playground +``` -- To view, visit https://gerrit.osmocom.org/c/osmo-ci/+/35264?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-ci Gerrit-Branch: master Gerrit-Change-Id: I9735eb30cf7260d211d5ea4da83ad09d31c93593 Gerrit-Change-Number: 35264 Gerrit-PatchSet: 1 Gerrit-Owner: osmith <osm...@sysmocom.de> Gerrit-MessageType: newchange
