From 2407cdc0fd08abf96999473f172acbe23bc2af33 Mon Sep 17 00:00:00 2001 From: "Lott, Christopher (cl778h)" Date: Wed, 29 Apr 2020 09:58:37 -0400 Subject: [PATCH] Upgrade to RMR version 4.0.2 Bump version to 1.0.3 and add release notes Add developer guide with guidance on bumping the version Signed-off-by: Lott, Christopher (cl778h) Change-Id: If2fd64c1791c549c674c0779d58d2ac0d4cf1f72 --- .gitignore | 4 ++++ Dockerfile-Unit-Test | 4 ++-- docs/developer-guide.rst | 37 +++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + docs/release-notes.rst | 5 +++++ examples/Dockerfile-Ping | 4 ++-- examples/Dockerfile-Pong | 4 ++-- rmr-version.yaml | 2 +- setup.py | 2 +- 9 files changed, 55 insertions(+), 8 deletions(-) create mode 100644 docs/developer-guide.rst diff --git a/.gitignore b/.gitignore index 8564645..ca538b8 100644 --- a/.gitignore +++ b/.gitignore @@ -109,3 +109,7 @@ ENV/ # Test report xunit-reports coverage-reports + +# Eclipse +.project +.settings/ diff --git a/Dockerfile-Unit-Test b/Dockerfile-Unit-Test index d509c18..e3aa77f 100644 --- a/Dockerfile-Unit-Test +++ b/Dockerfile-Unit-Test @@ -19,8 +19,8 @@ FROM python:3.8-alpine # sdl uses hiredis which needs gcc RUN apk update && apk add gcc musl-dev -# copy rmr .so from builder image in lieu of an Alpine package -COPY --from=nexus3.o-ran-sc.org:10002/o-ran-sc/bldr-alpine3-rmr:3.8.0 /usr/local/lib64/librmr_si.so /usr/local/lib64/librmr_si.so +# copy rmr libraries from builder image in lieu of an Alpine package +COPY --from=nexus3.o-ran-sc.org:10002/o-ran-sc/bldr-alpine3-rmr:4.0.2 /usr/local/lib64/librmr* /usr/local/lib64/ # Upgrade pip, install tox RUN pip install --upgrade pip && pip install tox diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst new file mode 100644 index 0000000..85a3cfd --- /dev/null +++ b/docs/developer-guide.rst @@ -0,0 +1,37 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Developer Guide +=============== + +.. contents:: + :depth: 3 + :local: + +Version bumping the framework +----------------------------- + +This project follows semver. When changes are made, the versions are in: + +1) ``docs/release-notes.rst`` + +2) ``setup.py`` + +Version bumping RMR +------------------- + +These items in this repo must be kept in sync: +* Dockerfile-Unit-Test +* examples/Dockerfile-Ping +* examples/Dockerfile-Pong +* ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins + + +Unit Testing +------------ + +You can run the unit tests in Docker to avoid installing RMR locally: + +:: + + docker build -f Dockerfile-Unit-Test . diff --git a/docs/index.rst b/docs/index.rst index 41d6630..09912b9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ xApp Python Framework installation-guide.rst overview.rst rmr_api.rst + developer-guide.rst release-notes.rst * :ref:`genindex` diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 79cc239..3ae4794 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -14,6 +14,11 @@ and this project adheres to `Semantic Versioning `__. :depth: 3 :local: +[1.0.3] - 2020-04-29 +-------------------- +* Upgrade to RMR version 4.0.2 + + [1.0.2] - 2020-04-22 -------------------- * Upgrade to RMR version 3.8.0 diff --git a/examples/Dockerfile-Ping b/examples/Dockerfile-Ping index 2eac495..acb32b8 100644 --- a/examples/Dockerfile-Ping +++ b/examples/Dockerfile-Ping @@ -16,11 +16,11 @@ # ================================================================================== FROM python:3.8-alpine +# copy rmr libraries from builder image in lieu of an Alpine package +COPY --from=nexus3.o-ran-sc.org:10002/o-ran-sc/bldr-alpine3-rmr:4.0.2 /usr/local/lib64/librmr* /usr/local/lib64/ # RMR setup RUN mkdir -p /opt/route/ COPY test_route.rt /opt/route/test_route.rt -# copy rmr .so from builder image in lieu of an Alpine package -COPY --from=nexus3.o-ran-sc.org:10002/o-ran-sc/bldr-alpine3-rmr:3.8.0 /usr/local/lib64/librmr_si.so /usr/local/lib64/librmr_si.so ENV LD_LIBRARY_PATH /usr/local/lib/:/usr/local/lib64 ENV RMR_SEED_RT /opt/route/test_route.rt diff --git a/examples/Dockerfile-Pong b/examples/Dockerfile-Pong index 4dfe71d..03d768a 100644 --- a/examples/Dockerfile-Pong +++ b/examples/Dockerfile-Pong @@ -16,11 +16,11 @@ # ================================================================================== FROM python:3.8-alpine +# copy rmr libraries from builder image in lieu of an Alpine package +COPY --from=nexus3.o-ran-sc.org:10002/o-ran-sc/bldr-alpine3-rmr:4.0.2 /usr/local/lib64/librmr* /usr/local/lib64/ # RMR setup RUN mkdir -p /opt/route/ COPY test_route.rt /opt/route/test_route.rt -# copy rmr .so from builder image in lieu of an Alpine package -COPY --from=nexus3.o-ran-sc.org:10002/o-ran-sc/bldr-alpine3-rmr:3.8.0 /usr/local/lib64/librmr_si.so /usr/local/lib64/librmr_si.so ENV LD_LIBRARY_PATH /usr/local/lib/:/usr/local/lib64 ENV RMR_SEED_RT /opt/route/test_route.rt diff --git a/rmr-version.yaml b/rmr-version.yaml index 2d82c45..48cb15e 100644 --- a/rmr-version.yaml +++ b/rmr-version.yaml @@ -1,3 +1,3 @@ # CI script installs RMR from PackageCloud using this version --- -version: 3.6.3 +version: 4.0.2 diff --git a/setup.py b/setup.py index e764a2e..85e017f 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ def _long_descr(): setup( name="ricxappframe", - version="1.0.2", + version="1.0.3", packages=find_packages(exclude=["tests.*", "tests"]), author="Tommy Carpenter, E. Scott Daniels", description="Xapp and RMR framework for python", -- 2.16.6