Lott, Christopher (cl778h) | 2407cdc | 2020-04-29 09:58:37 -0400 | [diff] [blame^] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| 3 | |
| 4 | Developer Guide |
| 5 | =============== |
| 6 | |
| 7 | .. contents:: |
| 8 | :depth: 3 |
| 9 | :local: |
| 10 | |
| 11 | Version bumping the framework |
| 12 | ----------------------------- |
| 13 | |
| 14 | This project follows semver. When changes are made, the versions are in: |
| 15 | |
| 16 | 1) ``docs/release-notes.rst`` |
| 17 | |
| 18 | 2) ``setup.py`` |
| 19 | |
| 20 | Version bumping RMR |
| 21 | ------------------- |
| 22 | |
| 23 | These items in this repo must be kept in sync: |
| 24 | * Dockerfile-Unit-Test |
| 25 | * examples/Dockerfile-Ping |
| 26 | * examples/Dockerfile-Pong |
| 27 | * ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins |
| 28 | |
| 29 | |
| 30 | Unit Testing |
| 31 | ------------ |
| 32 | |
| 33 | You can run the unit tests in Docker to avoid installing RMR locally: |
| 34 | |
| 35 | :: |
| 36 | |
| 37 | docker build -f Dockerfile-Unit-Test . |