20191107: Linux Foundation Jenkins CI tutorial: Defining Automated Jenkins Jobs for O-RAN SC Repos
PTLs: Please include the following status information for each project
It is sufficient to generate the release notes bases on docs/release-notes.rst in your repo as per https://wiki.o-ran-sc.org/display/DOC#DocumentationHome-RequiredFiles ans as per these templates https://wiki.o-ran-sc.org/display/DOC#DocumentationHome-Templates Other files you may also generate already now if you think this can be done in the remaining Amber timeframe (deadline = Nov-13, 8am ET): docs/installation-guides.rst, docs/developer-guide.rst , docs/api-docs.rst. The file docs/index.rst is also needed as seen in the next step (2.c.ii) below. For Amber release the minimum requirement is the release note file. There is no need to publish README.md file from your repo in readthedocs.io . We need to figure out aclever way to maintain it in the root directory (for github& co), but also to correctly trigger the general CI job that generates documentation.
PTL: Matti Hiltunen
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included | Proprietary info removed | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
RICAPP | ric-app/admin | Apache 2 | yes | yes | yes | yes | yes | yes | almost there | |
RICAPP | ric-app/mc | Apache 2 | yes | yes | yes | yes | yes | yes | soon | |
RICAPP | ric-app/ml | Apache 2 | yes | yes | yes | yes | yes | yes (some editing required) | ||
RICAPP | com/gs-lite | Apache 2 | yes | yes | yes | yes | N/A (library used by MC) |
PTL: Thoralf Czichy
(A) Project | (B) Repos | (C) License and Open Source Status | (D) Code and Building Status | (E) Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
(C.1) Apache2 or O-RAN | (C.2) Claims included? | (C.3) Proprietary info removed? | (D.1) Code available | (D.2) Buildable | (D.3) LF CI integrated | (E.1) Follow DOC | (E.2) DOC buildable | (E.3) Video demo | ||
RICP | com/log | Apache2 | yes | yes | yes | yes | yes | yes | no | no |
RICP | com/golog | Apache2 | yes | yes | yes | yes | yes | yes | no | no |
RICP | com/pylog | Apache2 | yes | yes | yes | yes | yes | yes | no | no |
RICP | ric-plt/a1 | Apache2 | yes | yes | yes | yes | yes | yes | yes | no |
RICP | ric-plt/appmgr | Apache2 | yes | yes | yes | yes | yes | no - only README in repo | no | no |
RICP | ric-plt/dbaas | Apache2 | yes | yes | yes | yes | yes | Yes (release-notes is done) | Yes | no |
RICP | ric-plt/e2 | Apache2 | yes | yes | yes | yes | yes | yes | no | no |
RICP | ric-plt/e2mgr | Apache2 | Yes | yes | yes | yes | yes | yes | no | no |
RICP | ric-plt/lib/rmr | Apache2 | yes | yes | yes | yes | yes | yes | yes - standard man pages built into dev package and RTD 'hooks' in docs/ | no |
RICP | ric-plt/nodeb-rnib | Apache2 | yes | yes | yes | yes | yes (empty) | no | no | |
RICP | ric-plt/rtmgr | Apache2 | yes | yes | yes | yes | yes | Only README | no | no |
RICP | ric-plt/sdl | Apache2 | yes | yes | yes | yes | yes | Yes (release-notes is done) | yes | no |
RICP | ric-plt/sdlgo | Apache2 | yes | yes | yes | yes | yes (verification only as this is a importable go module) | Yes (release-notes is done) | Yes | no |
RICP | ric-plt/submgr | Apache2 | Licence header missing in two files. Generated ASN1 codes are not under 3dparty directory. | yes | yes | yes | yes - includes only build job. No unit test available in the code. | Only README | no | no |
RICP | ric-plt/jaegeradapter | Apache2 | yes | yes | yes | Nothing to build in this repo | No, repo contains only helm chart for testing purposes | yes | no | no |
RICP | ric-plt/tracelibcpp | Apache2 | yes | yes | yes | yes | yes | yes | no | no |
RICP | ric-plt/tracelibgo | Apache2 | yes | yes | yes | yes | yes | yes | no | no |
RICP | ric-plt/vespamgr | Apache2 | yes | yes | yes | yes | yes | yes | no | no |
RICP | ric-plt/xapp-frame | Apache2 | yes | yes | yes | yes | N/A (Go library) | no | ||
RICP | ric-plt/asn1-documents | Creative Commons License, Attribution 4.0 Intl. | not applicable | not applicable | not applicable | no, only documentation | no, not needed | yes | no | |
RICP | ric-plt/streaming-protobufs | Creative Commons License, Attribution 4.0 Intl. | yes | yes | yes | no, not needed. Definitions to be used by other repos | no, planned for release B as a set of "unit tests". There's no CI/CD artifact resulting from this repo. | no, not needed | no, not needed | no |
RICP | ric-plt/resource-status-manager | Apache2 | yes | yes | yes | yes | yes | yes | no | no |
PTL: John Keeney
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
NONRTRIC | nonrtric | Apache 2.0 | Yes | No proprietary information | Yes | Yes | In progress | In progress | Soon |
PTL: Martin Skorupski
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
OAM | gerrit.o-ran-sc.org/r/q/oam | Apache 2.0 | Yes, file LICENSES.txt is in repo root; yes every code file has an appropriate header | No company proprietary info | Yes code is available in LF gerrit | Yes code is buildable | ||||
gerrit.o-ran-sc.org/r/admin/repos/scp/oam/modeling | O-RAN | No company proprietary info | n/a for modeling | n/a for modeling | n/a for modeling | n/a for modeling | n/a for modeling | n/a for modeling | ||
Apache 2.0 | Yes, file LICENSES.txt is in repo root; yes every code file has an appropriate header | No company proprietary info | Yes code is available in LF gerrit | Yes code is buildable | Yes the continuous integration (build) is performed in LF Jenkins | Yes documentation follows the format, structure and template of DOC | Yes documentation is included when the DOC project builds |
PTL: user-a934b
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
OCU | https://gerrit.o-ran-sc.org/r/scp/ocu/openlte | O-RAN | not yet | No company proprietary info | will upload before 11/04 working on the code upload now. | not yet | No | not yet | not yet | no |
PTL: Sachin Srivastava
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
ODUHIGH | Apache2 | Yes. LICENSE.txt is included at the root of the repo and each code file has a license and copyright claim header | Yes, company proprietary info is not included | Yes | Yes | No | Yes | Release notes doc has been placed inside doc folder of the o-du/l2 repo. |
PTL: Zhimin Yuan
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
ODULOW | https://gerrit.o-ran-sc.org/r/o-du/phy | Apache2 one file in external folder using MIT since gtest for unit test | Yes | Yes | Yes | Yes | can't do it since we need hard connection between two servers with 10G, 25G or 40G Nic, and configure them as a pair. just one docker can't do the testing. | not yet | no | no |
PTL: Xiaohua Zhang
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
INF | https://gerrit.o-ran-sc.org/r/admin/repos/pti/rtp | Apache2 | Yes | Yes, removed. | Yes | Yes | Ongoing | Not yet | No | No |
PTL: Alex Stancu
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
SIM | sim/o1-interface | Apache2 | No | No company proprietary info | Yes | Yes | No | No | No | No |
PTL: weichen ni
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
DOC | doc | CC 4.0 | No | No company proprietary info | N/A | N/A | N/A | In progress | no |
PTL: user-d3360
Project | Repos | License and Open Source Status | Code and Building Status | Documentation | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Apache2 or O-RAN | Claims included? | Proprietary info removed? | Code available | Buildable | LF CI integrated | Follow DOC | DOC buildable | Video demo | ||
INT | it/dep | Apache2 | Y | Y | Y | Y | Y | Y | Y | |
INT | it/test | Apache2 | Y | Y | Y | Y | Y | Y | Y | |
INT | it/dev | Apache2 | Y | Y | Y | N/A | N/A | Y | Y | N/A |
INT | it/otf | Apache2 | Y | Y | Y | Y | Y | Y | Y |