openmrsinfra/shields repository overview

⁠OpenMRS Shields

This tool looks up build and version information for OpenMRS repositories and generates shields.

⁠Usage

⁠Build Status

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://shields.openmrs.org/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://shields.openmrs.org/plan/PROJECT-KEY/PLAN-KEY

⁠Latest Module Version

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://shields.openmrs.org/version/MODULE-ID

⁠Module OpenMRS Version

To get the required OpenMRS version for a module, request:

https://shields.openmrs.org/omrsversion/MODULE-ID

⁠Custom Shields

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://shields.openmrs.org/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.

⁠Parameters

Shields can be customized using the following query parameters.

⁠Logo

Use the logo query parameter to add either the openmrs or esaude⁠ logo to your shield.

⁠Style

The style query parameter can be used to set the style of the shield to one of flat-square (default), flat or plastic.

:pushpin: Due to badges/shields#671⁠, it is not currently possible to use the style and logo parameters together.

⁠Examples

Description	URL	Result
OpenMRS Core Master Build Status	/build/TRUNK/MASTER⁠
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⁠

⁠Development

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⁠.

⁠License

MPL-2.0 w/ HD⁠