shields.io badges for OpenMRS repositories
This tool looks up build and version information for OpenMRS repositories and generates shields.
To get a shield for the build status of a project, look up the PROJECT-KEY and PLAN-KEY on the CI server and then request:
https://omrs-shields.psbrandt.io/build/PROJECT-KEY/PLAN-KEY
If you prefer the PROJECT-KEY and PLAN-KEY to appear on the shield, substitute
plan for build in the URL:
https://omrs-shields.psbrandt.io/plan/PROJECT-KEY/PLAN-KEY
To get the latest version of a module, visit the module page on Modulus to find the MODULE-ID (numeric value in the URL) and request:
https://omrs-shields.psbrandt.io/version/MODULE-ID
To get the required OpenMRS version for a module, request:
https://omrs-shields.psbrandt.io/omrsversion/MODULE-ID
Shields with custom labels and values can be generated at the /custom endpoint by adding label, value and color to the path. For example:
https://omrs-shields.psbrandt.io/custom/openmrs/rules/green
The value of color can be any of brightgreen , green, yellowgreen, yellow, orange, red, lightgrey, or blue, or a 6 character hex color code like 6a0888 or 81bef7.
Shields can be customized using the following query parameters.
Use the logo query parameter to add either the openmrs or esaude logo to your sheild.
The style query parameter can be used to set the style of the sheild to one of flat-square (default), flat or plastic.
📌 Due to badges/shields#671, it is not currently possible to use the style and logo parameters together.
| Description | URL | Result |
|---|---|---|
| Platform 2.0.x Build Status | /build/TRUNK/OC2 | |
| Logic Module Build Status | /build/LOGIC/LOGIC | |
| FHIR Module Build Status | /plan/FHIR/FM | |
| Rest Latest Version | /version/153 | |
| Rest OpenMRS Version | /omrsversion/153 | |
| Legacy UI Build Status | /plan/LU/LU?style=flat | |
| RefApp Build Status | /plan/REFAPP/OMODDISTRO?style=plastic | |
| App Framework Build Status | /plan/AF/AF?logo=openmrs | |
| Custom Message | /custom/custom/message/green?style=flat | |
| eSaude Version | /custom/esaude/v1.2.0/brightgreen?logo=esaude | |
| Unicorn Approved | /custom/unicorn/🦄_approved/ff69b4?logo=openmrs |
To run an OpenMRS Shields server locally, clone this repo, then install the dependencies:
npm install
Then run the server:
node index.js
Access the server at http://localhost:3033/build/TRUNK/OC2.