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
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

A simple Java client for ACINQ's [phoenixd REST API](https://phoenix.acinq.co/server/api). It wraps the HTTP endpoints and exposes typed requests and responses.

## Installation
Artifacts are published to a Reposilite server. Add the repository to your Maven configuration to resolve the artifacts:

```xml
<repositories>
<repository>
<id>reposilite-releases</id>
<url>https://maven.398ja.xyz/releases</url>
</repository>
</repositories>

<dependency>
<groupId>xyz.tcheeric</groupId>
<artifactId>phoenixd-rest</artifactId>
<version>1.0-SNAPSHOT</version>
Copy link

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version 1.0-SNAPSHOT in the installation example should be updated to reflect the actual released version or use a placeholder like ${project.version} to avoid confusion for users.

Suggested change
<version>1.0-SNAPSHOT</version>
<version>${project.version}</version>

Copilot uses AI. Check for mistakes.
</dependency>
```

## Requirements
- Java 21
- Maven
Expand Down
26 changes: 25 additions & 1 deletion docs/how-to/release.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# Release

Tag a commit with `v*` to trigger the release workflow. The workflow builds the JARs with `mvn -q package`, publishes them to GitHub Packages, and pushes a Docker image built from `phoenixd-rest/Dockerfile` to the GitHub Container Registry.
Tag a commit with `v*` to trigger the release workflow. The workflow builds the JARs with `mvn -q package`, publishes them to the Reposilite server, and pushes a Docker image built from `phoenixd-rest/Dockerfile` to the GitHub Container Registry.

Artifacts are published using the Reposilite repository. The parent `pom.xml` defines the distribution and resolution repositories:

```xml
<distributionManagement>
<repository>
<id>reposilite-releases</id>
<url>https://maven.398ja.xyz/releases</url>
</repository>
<snapshotRepository>
<id>reposilite-snapshots</id>
<url>https://maven.398ja.xyz/snapshots</url>
</snapshotRepository>
</distributionManagement>

<repositories>
<repository>
<id>reposilite-releases</id>
<url>https://maven.398ja.xyz/releases</url>
</repository>
</repositories>
```

Ensure your `~/.m2/settings.xml` includes credentials for the `reposilite-releases` and `reposilite-snapshots` servers before tagging a release.
18 changes: 18 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,24 @@
</dependencies>
</dependencyManagement>

<distributionManagement>
<repository>
<id>reposilite-releases</id>
<url>https://maven.398ja.xyz/releases</url>
</repository>
<snapshotRepository>
<id>reposilite-snapshots</id>
<url>https://maven.398ja.xyz/snapshots</url>
</snapshotRepository>
</distributionManagement>

<repositories>
<repository>
<id>reposilite-releases</id>
<url>https://maven.398ja.xyz/releases</url>
</repository>
</repositories>

<build>
<pluginManagement>
<plugins>
Expand Down
Loading