Skip to content

Commit 7b18326

Browse files
committed
Update README
1 parent 6561c93 commit 7b18326

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,97 @@ dependencies {
7373
</dependency>
7474
```
7575

76+
**Jbang:**
77+
78+
[Jbang](https://www.jbang.dev/) is very convinient to run scripts writen in Java having dependencies on third party libraries.
79+
80+
Just add this line at the top of your script:
81+
82+
```java
83+
//DEPS org.gitlab4j:gitlab4j-api:5.3.0
84+
```
85+
7686
**Ivy and SBT**<br/>
7787
There have been reports of problems resolving some dependencies when using Ivy or SBT, for help resolving those issues see:<br/>
7888
<a href="https://github.com/eclipse-ee4j/jaxrs-api/issues/571">JAX-RS API Issue #571</a><br/>
7989
<a href="https://github.com/eclipse-ee4j/jaxrs-api/issues/572">JAX-RS API Issue #572</a>
8090

91+
### **Lastest version**
92+
93+
While we are frequently creating releases, you might be interested by a feature that has not been published yet.
94+
You can use jars created by [jitpack](https://jitpack.io/) to get the newest version.
95+
96+
**Usage with gradle:**
97+
98+
```gradle
99+
repositories {
100+
mavenCentral()
101+
maven {
102+
url "https://jitpack.io"
103+
content {
104+
includeGroup "com.github.gitlab4j"
105+
}
106+
}
107+
}
108+
109+
dependencies {
110+
// ...
111+
implementation 'com.github.gitlab4j:gitlab4j-api:main-SNAPSHOT'
112+
// ...
113+
}
114+
```
115+
116+
**Usage with maven:**
117+
118+
```xml
119+
<repositories>
120+
<repository>
121+
<id>jitpack.io</id>
122+
<url>https://jitpack.io</url>
123+
</repository>
124+
</repositories>
125+
126+
<dependencies>
127+
<dependency>
128+
<groupId>com.github.gitlab4j</groupId>
129+
<artifactId>gitlab4j-api</artifactId>
130+
<version>main-SNAPSHOT</version>
131+
</dependency>
132+
<!-- ... -->
133+
</dependencies>
134+
```
135+
136+
**Usage with jbang:**
137+
138+
You just need to declare the dependency like this, instead of using the maven coordinates:
139+
140+
```java
141+
//DEPS https://github.com/gitlab4j/gitlab4j-api/tree/main#:SNAPSHOT
142+
```
143+
144+
**Using a specific commit**
145+
146+
Version `main-SNAPSHOT` indicates that you would like to get the latest of the `main` branch.
147+
You can also point to a specific commit:
148+
149+
```gradle
150+
dependencies {
151+
implementation 'com.github.gitlab4j:gitlab4j-api:6561c93aaf'
152+
}
153+
```
154+
155+
```xml
156+
<dependency>
157+
<groupId>com.github.gitlab4j</groupId>
158+
<artifactId>gitlab4j-api</artifactId>
159+
<version>6561c93aaf</version>
160+
</dependency>
161+
```
162+
163+
```java
164+
//DEPS https://github.com/gitlab4j/gitlab4j-api/tree/6561c93aafa6bf35cb9bad0617127a0c249a8f9f
165+
```
166+
81167
---
82168

83169
### **Usage Examples**

0 commit comments

Comments
 (0)