Skip to content

Commit d8578c2

Browse files
committed
fix pipeline
1 parent fd2ab0d commit d8578c2

File tree

2 files changed

+47
-15
lines changed

2 files changed

+47
-15
lines changed

README.md

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,27 @@ A Java client library for interacting with the DatabunkerPro API. DatabunkerPro
2727

2828
## Installation
2929

30-
### From JitPack (Recommended)
30+
### From GitHub Packages
31+
32+
Add the repository and dependency to your `pom.xml`:
33+
34+
```xml
35+
<repositories>
36+
<repository>
37+
<id>github</id>
38+
<name>GitHub Packages</name>
39+
<url>https://maven.pkg.github.com/securitybunker/databunkerpro-java</url>
40+
</repository>
41+
</repositories>
42+
43+
<dependency>
44+
<groupId>org.databunker</groupId>
45+
<artifactId>databunkerpro-java</artifactId>
46+
<version>1.0.0-SNAPSHOT</version>
47+
</dependency>
48+
```
49+
50+
### From JitPack (Alternative)
3151

3252
Add the JitPack repository and dependency to your `pom.xml`:
3353

@@ -142,9 +162,25 @@ mvn test
142162

143163
## Deployment
144164

145-
This project uses **JitPack** for automatic deployment. JitPack automatically builds and publishes your GitHub repository as a Maven dependency.
165+
The project supports deployment to both GitHub Packages and JitPack.
166+
167+
### GitHub Packages Deployment
168+
169+
The project includes a GitHub Actions workflow that automatically:
170+
- Builds the project on push to main branch
171+
- Runs tests
172+
- Deploys to GitHub Packages when triggered
146173

147-
### How to Release a New Version
174+
To deploy:
175+
1. Go to Actions tab in your GitHub repository
176+
2. Select "Build java API" workflow
177+
3. Click "Run workflow"
178+
4. Set "Deploy to GitHub Packages" to true
179+
5. Click "Run workflow"
180+
181+
### JitPack Deployment (Alternative)
182+
183+
JitPack automatically builds and publishes your GitHub repository as a Maven dependency.
148184

149185
1. **Create a Git tag** for your release:
150186
```bash
@@ -154,18 +190,7 @@ This project uses **JitPack** for automatic deployment. JitPack automatically bu
154190

155191
2. **JitPack automatically builds** and publishes the package
156192

157-
3. **Users can then install** using the version tag:
158-
```xml
159-
<dependency>
160-
<groupId>com.github.securitybunker</groupId>
161-
<artifactId>databunkerpro-java</artifactId>
162-
<version>v1.0.0</version>
163-
</dependency>
164-
```
165-
166-
### View Build Status
167-
168-
Check your build status at: https://jitpack.io/#securitybunker/databunkerpro-java
193+
3. **Check build status** at: https://jitpack.io/#securitybunker/databunkerpro-java
169194

170195
## Contributing
171196

pom.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,13 @@
5050
</dependency>
5151
</dependencies>
5252

53+
<distributionManagement>
54+
<repository>
55+
<id>github</id>
56+
<name>GitHub Packages</name>
57+
<url>https://maven.pkg.github.com/securitybunker/databunkerpro-java</url>
58+
</repository>
59+
</distributionManagement>
5360

5461

5562
<scm>

0 commit comments

Comments
 (0)