https://github.com/sbcgua/abap-package-version-shield

shield.io lambda to detect version of abap package, serialized by abapGit
https://github.com/sbcgua/abap-package-version-shield

abap badge hacktoberfest lambda shields

Last synced: about 2 months ago
JSON representation

shield.io lambda to detect version of abap package, serialized by abapGit

• Host: GitHub
• URL: https://github.com/sbcgua/abap-package-version-shield
• Owner: sbcgua
• Created: 2020-01-08T16:38:37.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-31T07:12:26.000Z (5 months ago)
• Last Synced: 2024-10-24T01:32:02.494Z (2 months ago)
• Topics: abap, badge, hacktoberfest, lambda, shields
• Language: JavaScript
• Homepage: https://sbcgua.github.io/abap-package-version-shield
• Size: 1.69 MB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.txt

Awesome Lists containing this project

README

        
[![Known Vulnerabilities](https://snyk.io/test/github/sbcgua/abap-package-version-shield/badge.svg?targetFile=package.json)](https://snyk.io/test/github/sbcgua/abap-package-version-shield?targetFile=package.json)

![Version](https://img.shields.io/github/v/tag/sbcgua/abap-package-version-shield.svg)

# ABAP package version shield

## Usage

There is an amazing service [shields.io](https://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.

![shield sample](docs/shield-sample.svg)

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`](https://img.shields.io/endpoint?url=https://shield.abap.space/version-shield-json/github/sbcgua/mockup_loader/src/zif_mockup_loader.intf.abap/version)

![example](docs/code-example.png)

### Notes

- The version is supposed to be in [semantic version](https://semver.org/) 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](https://github.com/sbcgua/abap-package-version-shield/issues/1)). `'...apack-manifest.xml/dependencies//'`.

- 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](https://shields.io/). 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](https://sbcgua.github.io/abap-package-version-shield#badge-constructor)