https://github.com/joschi/docker-japi-tracker

Docker image for Java API Tracker
https://github.com/joschi/docker-japi-tracker

abi-compatibility docker docker-image java

Last synced: 2 months ago
JSON representation

Docker image for Java API Tracker

• Host: GitHub
• URL: https://github.com/joschi/docker-japi-tracker
• Owner: joschi
• License: mit
• Created: 2019-11-11T07:19:40.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-16T11:22:14.000Z (over 6 years ago)
• Last Synced: 2024-10-06T02:41:59.565Z (over 1 year ago)
• Topics: abi-compatibility, docker, docker-image, java
• Language: Dockerfile
• Homepage: https://abi-laboratory.pro/java/tracker/
• Size: 4.88 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Java API Tracker Docker image

[![Docker Stars](https://img.shields.io/docker/stars/joschi/japi-tracker.svg)][hub]

[![Docker Pulls](https://img.shields.io/docker/pulls/joschi/japi-tracker.svg)][hub]

[![Image Size](https://images.microbadger.com/badges/image/joschi/japi-tracker.svg)][microbadger]

[![Image Version](https://images.microbadger.com/badges/version/joschi/japi-tracker.svg)][microbadger]

[![Image License](https://images.microbadger.com/badges/license/joschi/japi-tracker.svg)][microbadger]

[hub]: https://hub.docker.com/r/joschi/japi-tracker/

[microbadger]: https://microbadger.com/images/joschi/japi-tracker

## What is Java API Tracker?

A tool to visualize the API changes timeline of a Java library

Homepage: https://github.com/lvc/japi-tracker

### Examples

Use the following command to compare the versions of a Java library (SLF4J) using the `slf4j.json` profile:

```

# docker run -v "${PWD}":/workspace --rm joschi/japi-tracker:1.3-1 japi-monitor -get -build-new slf4j.json

# docker run -v "${PWD}":/workspace --rm joschi/japi-tracker:1.3-1 japi-tracker -build slf4j.json

```

The compatibility reports will be written into the `/workspace` directory.

See https://github.com/lvc/upstream-tracker-4j for numerous example profiles.

## Profile Format

```json

{

  "Name":        "SHORT LIBRARY NAME",

  "SourceUrl":   "URL TO DOWNLOAD PACKAGES",

  "Maintainer":  "MAINTAINER NAME",

  

  "Versions": [

  {

    "Number":      "VERSION NUMBER",

    "Installed":   "INSTALL TREE PATH",

    "Source":      "SOURCE PACKAGE PATH",

    "Changelog":   "CHANGELOG: On/Off",

    "PkgDiff":     "PACKAGE DIFF: On/Off"

  },

  

  ...

  

  {

      ...

  }]

}

```

## License

This Docker image is licensed under the MIT license, see [LICENSE](LICENSE).