Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into 6.x
Browse files Browse the repository at this point in the history
  • Loading branch information
jmini committed Nov 8, 2023
2 parents b614859 + 7b18326 commit ba5382c
Showing 1 changed file with 86 additions and 0 deletions.
86 changes: 86 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,97 @@ dependencies {
</dependency>
```

**Jbang:**

[Jbang](https://www.jbang.dev/) is very convinient to run scripts writen in Java having dependencies on third party libraries.

Just add this line at the top of your script:

```java
//DEPS org.gitlab4j:gitlab4j-api:6.0.0-rc.2
```

**Ivy and SBT**<br/>
There have been reports of problems resolving some dependencies when using Ivy or SBT, for help resolving those issues see:<br/>
<a href="https://github.com/eclipse-ee4j/jaxrs-api/issues/571">JAX-RS API Issue #571</a><br/>
<a href="https://github.com/eclipse-ee4j/jaxrs-api/issues/572">JAX-RS API Issue #572</a>

### **Lastest version**

While we are frequently creating releases, you might be interested by a feature that has not been published yet.
You can use jars created by [jitpack](https://jitpack.io/) to get the newest version.

**Usage with gradle:**

```gradle
repositories {
mavenCentral()
maven {
url "https://jitpack.io"
content {
includeGroup "com.github.gitlab4j"
}
}
}
dependencies {
// ...
implementation 'com.github.gitlab4j:gitlab4j-api:6.x-SNAPSHOT'
// ...
}
```

**Usage with maven:**

```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>com.github.gitlab4j</groupId>
<artifactId>gitlab4j-api</artifactId>
<version>6.x-SNAPSHOT</version>
</dependency>
<!-- ... -->
</dependencies>
```

**Usage with jbang:**

You just need to declare the dependency like this, instead of using the maven coordinates:

```java
//DEPS https://github.com/gitlab4j/gitlab4j-api/tree/6.x#:SNAPSHOT
```

**Using a specific commit**

Version `6.x-SNAPSHOT` indicates that you would like to get the latest of the `main` branch.
You can also point to a specific commit:

```gradle
dependencies {
implementation 'com.github.gitlab4j:gitlab4j-api:b6148593a3'
}
```

```xml
<dependency>
<groupId>com.github.gitlab4j</groupId>
<artifactId>gitlab4j-api</artifactId>
<version>b6148593a3</version>
</dependency>
```

```java
//DEPS https://github.com/gitlab4j/gitlab4j-api/tree/b6148593a3405cc60968bd247cd7910aae9375e2
```

---

### **Usage Examples**
Expand Down

0 comments on commit ba5382c

Please sign in to comment.