Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .github/workflows/increment-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ name: Increment Version
on:
workflow_dispatch:
inputs:
release-version:
description: "release-version"
required: true
default: "0.25.1"
old-version:
description: "old-version"
required: true
default: "0.25.0"
release-version:
description: "release-version"
required: true
default: "0.25.1"

jobs:
run-script:
Expand Down
34 changes: 34 additions & 0 deletions .github/workflows/mvn-set-version.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Increment Version

on:
workflow_dispatch:
inputs:
new-version:
description: "new-version"
required: true
default: "0.25.0-SNAPSHOT"

jobs:
run-script:
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v4

- name: Setup Java
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 21
cache: maven

- name: Build with Maven
shell: bash
run: |
git config user.name '${{ github.actor }}'
git config user.email '${{ github.actor }}@users.noreply.github.com'
mvn versions:set -DnewVersion="${{ inputs.new-version }}"
mvn versions:commit
git commit -a -m "mvn set version to ${{ inputs.new-version }}"
git push origin
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ japicmp is available in the Maven Central Repository:
<dependency>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
</dependency>
```
A maven plugin allows you to integrate the checks into your build:
Expand All @@ -27,7 +27,7 @@ A maven plugin allows you to integrate the checks into your build:
<plugin>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp-maven-plugin</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
<configuration>
<oldVersion>
<dependency>
Expand Down Expand Up @@ -152,11 +152,7 @@ This is the release procedure:
mvn versions:set -DnewVersion=<version>-SNAPSHOT
mvn versions:commit
```
* Increment version in README.md / Site-Report
``` bash
python3 release.py --release-version <release-version> --old-version <old-version>
```
* Push changes to remote repository.
* Increment version in README.md / Site-Report by running [this Action](https://github.com/siom79/japicmp/actions/workflows/increment-version.yml) on the release branch
* Run release [Action](https://github.com/siom79/japicmp/actions/workflows/release.yml)
* Login to [Central repository](https://central.sonatype.com/publishing)
* Download released artifact from staging repository.
Expand Down
5 changes: 2 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.github.siom79.japicmp</groupId>
Expand Down Expand Up @@ -448,7 +447,7 @@
<connection>scm:git:https://github.com/${github.account}/${github.project}.git</connection>
<developerConnection>scm:git:https://github.com/${github.account}/${github.project}.git</developerConnection>
<url>https://github.com/${github.account}/${github.project}.git</url>
<tag>japicmp-base-0.24.2</tag>
<tag>japicmp-base-0.25.2</tag>
</scm>

<distributionManagement>
Expand Down
6 changes: 3 additions & 3 deletions src/site/markdown/CliTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,18 +147,18 @@ When your library implements interfaces or extends classes from other libraries
compatibility you must specify the classpath for the two different versions:

```bash
java -jar japicmp-0.25.2-jar-with-dependencies.jar -n new-version.jar -o old-version.jar --new-classpath other-library-v2.jar
java -jar japicmp-0.25.3-jar-with-dependencies.jar -n new-version.jar -o old-version.jar --new-classpath other-library-v2.jar
--old-classpath other-library-v1.jar
```

In case the classpath for both versions did not change, you can add the library using the standard way:

```bash
java -cp japicmp-0.25.2-jar-with-dependencies.jar;otherLibrary.jar japicmp.JApiCmp -n new-version.jar -o old-version.jar
java -cp japicmp-0.25.3-jar-with-dependencies.jar;otherLibrary.jar japicmp.JApiCmp -n new-version.jar -o old-version.jar
```

For reporting purposes you can also provide more than one jar as old or new version(s):

```bash
java -jar japicmp-0.25.2-jar-with-dependencies.jar -o lib1-old.jar;lib2-old.jar -n lib1-new.jar;lib2-new.jar
java -jar japicmp-0.25.3-jar-with-dependencies.jar -o lib1-old.jar;lib2-old.jar -n lib1-new.jar;lib2-new.jar
```
12 changes: 6 additions & 6 deletions src/site/markdown/MavenPlugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The maven plugin can be included in the pom.xml file of your artifact in the fol
<plugin>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp-maven-plugin</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
<configuration>
<oldVersion>
<dependency>
Expand Down Expand Up @@ -46,7 +46,7 @@ You can also leave out the &lt;oldVersion&gt; and &lt;newVersion&gt; elements:
<plugin>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp-maven-plugin</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
<configuration>
<parameter>
<!-- see documentation -->
Expand All @@ -70,7 +70,7 @@ to configure the latest version more precisely (e.g. only GA versions), then you
<plugin>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp-maven-plugin</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
<configuration>
<parameter>
<oldVersionPattern>\d+\.\d+\.\d+\.GA</oldVersionPattern>
Expand Down Expand Up @@ -116,13 +116,13 @@ An advanced configuration can utilize the following parameters:
<plugin>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp-maven-plugin</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
<configuration>
<oldVersion>
<dependency>
<groupId>japicmp</groupId>
<artifactId>japicmp-test-v1</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
<type>jar</type>
</dependency>
</oldVersion>
Expand Down Expand Up @@ -382,7 +382,7 @@ Alternatively it can be used inside the `<reporting/>` tag in order to be invoke
<plugin>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp-maven-plugin</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
<reportSets>
<reportSet>
<reports>
Expand Down
6 changes: 3 additions & 3 deletions src/site/markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ japicmp
japicmp is a tool to compare two versions of a jar archive:

```bash
java -jar japicmp-0.25.2-jar-with-dependencies.jar -n new-version.jar -o old-version.jar
java -jar japicmp-0.25.3-jar-with-dependencies.jar -n new-version.jar -o old-version.jar
```

It can also be used as a library:
Expand All @@ -21,7 +21,7 @@ japicmp is available in the Maven Central Repository:
<dependency>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
</dependency>
```

Expand All @@ -31,7 +31,7 @@ A maven plugin allows you to integrate the checks into your build:
<plugin>
<groupId>com.github.siom79.japicmp</groupId>
<artifactId>japicmp-maven-plugin</artifactId>
<version>0.25.2</version>
<version>0.25.3</version>
<configuration>
<oldVersion>
<dependency>
Expand Down