Go to file
Marc Mattmüller c304cf9954 doc: added new chapter with title CI within Bitbucket
the topic about using the Git server (Bitbucket or GitLab) for
user-space applications has driven me into that direction.
Unfortunately there is a lack of information and permission to
move on with this topic. Thus, I postponed it until I get some
news :-)

Signed-off-by: Marc Mattmüller <marc.mattmueller@netmodule.com>
2023-06-05 13:18:49 +02:00
collections playbooks,collections: renamed to .yml and added collection requirements 2023-05-02 13:14:31 +02:00
doc doc: added new chapter with title CI within Bitbucket 2023-06-05 13:18:49 +02:00
inventory playbooks,inventory: added playbook installing basic tools on a VM 2023-05-15 18:18:19 +02:00
jobs jobs/build: use default target when job is triggered by timer 2023-05-01 09:11:19 +02:00
playbooks/getting_started playbook/clone-repo: replaced bitbucket name with ip 2023-05-22 16:09:42 +02:00
.gitignore README,doc: added next-level-CI and NWL-CI documentation 2023-04-18 16:05:34 +02:00
README.md doc,ansible: documented setup of AWX, added structure for a first playbook 2023-05-02 12:40:20 +02:00
ansible.cfg ansible.cfg,os-rls.yml: added configuration for files and fixed var 2023-05-09 15:19:43 +02:00

README.md

NetModule Wireless Linux CI/CD Repository

This repository contains all necessary jobs for the CI/CD environment of the NetModule Wireless Linux (NWL).

Content

This repository holds the documentation for the CI environment and the jobs for the NWL as declarative pipelines (multibranch):

  • doc

    • the documentation of the work for the NWL CI environment
  • jobs

    • Jenkinsfile_Build

      • a pipeline building a NWL yocto target
    • Jenkinsfile_Common

      • a collection of commonly used functions, so that duplicated code can be avoided
  • inventory

    • Ansible inventory with all managed hosts/devices
  • playbooks

    • Ansible playbooks

Marginal Notes

This repository does NOT cover the setup of the Jenkins instance.

Building the Documentation

The documentation bases on sphinx and is written in reStructuredText format. To build the documenation you need to install sphinx first:

sudo apt install python3-sphinx
sudo pip3 install cloud-sptheme

Within the directory doc you can use make as follows:

# entering doc:
cd doc

# clean and build the documentation:
make clean
make html

# open the generated documentation in the browser:
xdg-open out/html/index.html

cd ..