Skip to content

Commit

Permalink
Merge pull request #28 from mk868/switch-to-maven
Browse files Browse the repository at this point in the history
Removal of Ant in favor of Maven
  • Loading branch information
ianopolous authored Aug 22, 2024
2 parents be050c8 + 88841f8 commit e82915a
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 103 deletions.
21 changes: 0 additions & 21 deletions .github/workflows/ant.yml

This file was deleted.

21 changes: 21 additions & 0 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Java CI

on: [push]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Set up JDK 11
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 11
- name: Build with Maven
run: mvn -B test-compile
- name: Run tests with Maven
timeout-minutes: 10
run: mvn -B test
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,7 @@ This is the [cid](https://github.com/ipld/cid) implementation in Java.
- [Usage](#usage)
- [Dependency](#dependency)
- [Testing](#testing)
- [Ant](#ant)
- [Maven](#maven)
- [Building](#building)
- [Ant](#ant-1)
- [Maven](#maven-1)
- [Releasing](#releasing)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
Expand All @@ -30,14 +26,14 @@ Simply clone this repo.

## Usage

```
```java
Cid cid = Cid.decode("zdpuAyvkgEDQm9TenwGkd5eNaosSxjgEYd8QatfPetgB1CdEZ");
```
## Dependency
You can use this project by building the JAR file as specified below, or by using [JitPack](https://jitpack.io/#ipld/java-cid/) (also supporting Gradle, SBT, etc).

for Maven, you can add the follwing sections to your POM.XML:
```
```xml
<repositories>
<repository>
<id>jitpack.io</id>
Expand All @@ -56,22 +52,15 @@ for Maven, you can add the follwing sections to your POM.XML:

## Testing

### Ant
`ant test`

### Maven
`mvn test`

## Building

### Ant
`ant dist` will build a JAR file in the `./dist` suitable for manual inclusion in a project. Dependent libraries are included in `./dist/lib`.

### Maven
`mvn package` will build a JAR file with Maven dependency information.

## Releasing
The version number is specified in `build.xml` and `pom.xml` and must be changed in both places in order to be accurately reflected in the JAR file manifest. A git tag must be added in the format "vx.x.x" for JitPack to work.

The version number is specified in the `pom.xml` file and must be changed in order to be accurately reflected in the JAR file manifest. A git tag must be added in the format "vx.x.x" for JitPack to work.

## Maintainers

Expand Down
67 changes: 0 additions & 67 deletions build.xml

This file was deleted.

Binary file removed lib/hamcrest-2.2.jar
Binary file not shown.
Binary file removed lib/junit-4.13.2.jar
Binary file not shown.
Binary file removed lib/multibase.jar
Binary file not shown.
Binary file removed lib/multihash.jar
Binary file not shown.

0 comments on commit e82915a

Please sign in to comment.