ABAP package version shield

ANNOUNCEMENT: Mid January 2025 the URL shield.abap.space will be changed to something else (will announce later) due to luck of funding for the domain name.

Usage

There is an amazing service shields.io that produces github status badges. In particular, it can retrieve shield configuration from another API. This piece of code implements such API endpoint for extracting abap package version.

The service is available at shield.abap.space domain. In order to add a badge to your repository add the following line at the top of your root readme file.

![abap package version](https://img.shields.io/endpoint?url=https://shield.abap.space/version-shield-json/$TYPE/$OWNER/$REPO/$PATH/$CONSTANT_NAME)

where:

• $TYPE = 'github' (only this for now)
• $OWNER = your github user name
• $REPO = you repo name
• $PATH = path to abap file with version constant
• $CONSTANT_NAME = constant name to search version in (optional, "version" by default)

For example: https://img.shields.io/endpoint?url=https://shield.abap.space/version-shield-json/github/sbcgua/mockup_loader/src/zif_mockup_loader.intf.abap/version

Notes

• The version is supposed to be in semantic version format - e.g. 'X.Y.Z' or 'vX.Y.Z' or 'vX.Y.Z-beta' - the version string is validated and a wrongly formatted one will not pass (e.g. 'X.Y' is not valid)
• if $PATH = .apack-manifest.xml the version is read directly from that file.
• apack parsing also supports displaying dependency version (see issue #1). '...apack-manifest.xml/dependencies/<group_id>/<artifact_id>'.
• namespaced filenames and structured constants (begin of...) are also supported

Badge customizing

Shields.io allows to override some of parameters e.g. label and color - see more in their documentation. For example: https://img.shields.io/endpoint?url=...&label=version&color=red to display the shield in red and with shorter "version" label instead of "abap package version".

N.B. Please report bugs if found :)

Badge constructor

Interactive badge constructor is available at this repository github page