Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Maven and Docker image coordinates #172

Merged
merged 5 commits into from
Oct 13, 2020
Merged

Update Maven and Docker image coordinates #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4eecf0e
Move Maven coordinates to new group ID and artifact IDs
joschi Sep 21, 2020
a7e4f99
Replace maven-assembly-plugin with maven-shade-plugin
joschi Sep 21, 2020
377efd5
Add openapi-diff-core to dependencyManagement in Parent POM
joschi Sep 21, 2020
15e96e6
Update SCM information in Parent POM
joschi Sep 21, 2020
e816ffc
Update Maven coordinates and Docker image in README.md
joschi Sep 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Compare two OpenAPI specifications (3.x) and render the difference to HTML plaintext, or Markdown files.

[![Test](https://github.com/OpenAPITools/openapi-diff/workflows/Test/badge.svg)](https://github.com/OpenAPITools/openapi-diff/actions?query=branch%3Amaster+workflow%3ATest+)

[![Maven Central](https://img.shields.io/maven-central/v/org.openapitools.openapidiff/openapi-diff-core)](https://search.maven.org/artifact/org.openapitools.openapidiff/openapi-diff-core)
[![Join the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM)

# Requirements
Expand All @@ -20,22 +20,22 @@ Compare two OpenAPI specifications (3.x) and render the difference to HTML plain

# Maven

Available on [Maven Central](https://search.maven.org/artifact/com.github.joschi.openapi-diff/core)
Available on [Maven Central](https://search.maven.org/artifact/org.openapitools.openapidiff/openapi-diff-core)

```xml
<dependency>
<groupId>com.github.joschi.openapi-diff</groupId>
<artifactId>core</artifactId>
<groupId>org.openapitools.openapidiff</groupId>
<artifactId>openapi-diff-core</artifactId>
<version>${openapi-diff-version}</version>
</dependency>
```

# Docker

Available on [Docker Hub](https://hub.docker.com/r/joschi/openapi-diff/) as `joschi/openapi-diff`.
Available on [Docker Hub](https://hub.docker.com/r/openapitools/openapi-diff/) as `openapitools/openapi-diff`.

```bash
# docker run joschi/openapi-diff:latest
# docker run openapitools/openapi-diff:latest
usage: openapi-diff <old> <new>
--debug Print debugging information
--error Print error information
Expand Down Expand Up @@ -79,10 +79,10 @@ in readonly mode (`ro`).
```bash
docker run -t \
-v $(pwd)/core/src/test/resources:/specs:ro \
joschi/openapi-diff /specs/path_1.yaml /specs/path_2.yaml
openapitools/openapi-diff /specs/path_1.yaml /specs/path_2.yaml
```

The remote name `joschi/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.
The remote name `openapitools/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.

# Usage

Expand Down
40 changes: 20 additions & 20 deletions cli/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,21 @@
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>com.github.joschi.openapi-diff</groupId>
<artifactId>parent</artifactId>
<groupId>org.openapitools.openapidiff</groupId>
<artifactId>openapi-diff-parent</artifactId>
<version>2.0.0-SNAPSHOT</version>
</parent>

<artifactId>cli</artifactId>
<artifactId>openapi-diff-cli</artifactId>
<packaging>jar</packaging>

<name>openapi-diff-cli</name>
<description>CLI for openapi-diff</description>

<dependencies>
<dependency>
<groupId>com.github.joschi.openapi-diff</groupId>
<artifactId>core</artifactId>
<version>2.0.0-SNAPSHOT</version>
<groupId>org.openapitools.openapidiff</groupId>
<artifactId>openapi-diff-core</artifactId>
</dependency>
<dependency>
<groupId>commons-cli</groupId>
Expand All @@ -40,25 +39,26 @@
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
<archive>
<manifest>
<mainClass>com.qdesrame.openapi.diff.cli.Main</mainClass>
</manifest>
</archive>
<finalName>openapi-diff</finalName>
</configuration>
<artifactId>maven-shade-plugin</artifactId>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
<goal>shade</goal>
</goals>
<configuration>
<createDependencyReducedPom>false</createDependencyReducedPom>
<shadedArtifactAttached>true</shadedArtifactAttached>
<shadedClassifierName>all</shadedClassifierName>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>com.qdesrame.openapi.diff.cli.Main</mainClass>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
<transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer"/>
<transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer"/>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
Expand Down
6 changes: 3 additions & 3 deletions core/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>com.github.joschi.openapi-diff</groupId>
<artifactId>parent</artifactId>
<groupId>org.openapitools.openapidiff</groupId>
<artifactId>openapi-diff-parent</artifactId>
<version>2.0.0-SNAPSHOT</version>
</parent>

<artifactId>core</artifactId>
<artifactId>openapi-diff-core</artifactId>
<packaging>jar</packaging>

<name>openapi-diff-core</name>
Expand Down
25 changes: 15 additions & 10 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
<module>cli</module>
</modules>

<groupId>com.github.joschi.openapi-diff</groupId>
<artifactId>parent</artifactId>
<groupId>org.openapitools.openapidiff</groupId>
<artifactId>openapi-diff-parent</artifactId>
<version>2.0.0-SNAPSHOT</version>
<packaging>pom</packaging>

Expand All @@ -40,9 +40,9 @@
</developers>

<scm>
<connection>scm:git:https://github.com/joschi/openapi-diff.git</connection>
<developerConnection>scm:git:https://github.com/joschi/openapi-diff.git</developerConnection>
<url>https://github.com/joschi/openapi-diff</url>
<connection>scm:git:https://github.com/OpenAPITools/openapi-diff.git</connection>
<developerConnection>scm:git:https://github.com/OpenAPITools/openapi-diff.git</developerConnection>
<url>https://github.com/OpenAPITools/openapi-diff</url>
<tag>HEAD</tag>
</scm>

Expand Down Expand Up @@ -71,6 +71,11 @@

<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.openapitools.openapidiff</groupId>
<artifactId>openapi-diff-core</artifactId>
<version>2.0.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.junit</groupId>
<artifactId>junit-bom</artifactId>
Expand Down Expand Up @@ -219,11 +224,6 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.3.0</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
Expand All @@ -249,6 +249,11 @@
<artifactId>maven-deploy-plugin</artifactId>
<version>2.8.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.2.4</version>
</plugin>
</plugins>
</pluginManagement>
<plugins>
Expand Down