BitAspire Wiki

Published Packages

Maven repository URL, published artifact coordinates, Gradle and Maven dependency snippets for SIR modules, commands, and the core API.

Maven repository

The SIR publish workflow deploys the API jar, individual module jars, individual command-provider jars, and two aggregate POMs to the CroaBeast Maven repository.

The main plugin jar SIR-2.3.1.jar is uploaded as a GitHub Actions artifact by the workflow. It is not deployed as a Maven library artifact.

https://croabeast.github.io/repo/

Core API dependency

Use this coordinate when compiling an integration, command provider, module, or SIR+ addon against the shared API.

Gradle Kotlin

val sirVersion = "2.3.1"

repositories {
    maven("https://croabeast.github.io/repo/")
}

dependencies {
    implementation("com.bitaspire.sir:api:$sirVersion")
}

Gradle Groovy

def sirVersion = '2.3.1'

repositories {
    maven { url = uri('https://croabeast.github.io/repo/') }
}

dependencies {
    implementation "com.bitaspire.sir:api:$sirVersion"
}

Maven

<repositories>
  <repository>
    <id>croabeast</id>
    <url>https://croabeast.github.io/repo/</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>com.bitaspire.sir</groupId>
    <artifactId>api</artifactId>
    <version>2.3.1</version>
  </dependency>
</dependencies>

Published API artifact

GroupArtifactPackagingCoordinate
com.bitaspire.sirapijarcom.bitaspire.sir:api:2.3.1

If your build creates fat jars or shaded jars, verify the final artifact before release. Normal addons and integrations should compile against SIR API, not bundle a second private copy of the API classes.


Published module artifacts

The workflow publishes each module jar under com.bitaspire.sir.module.

val sirVersion = "2.3.1"

repositories {
    maven("https://croabeast.github.io/repo/")
}

dependencies {
    implementation("com.bitaspire.sir.module:channels:$sirVersion")
    implementation("com.bitaspire.sir.module:moderation:$sirVersion")
}
ArtifactCoordinate
advancementscom.bitaspire.sir.module:advancements:2.3.1
announcementscom.bitaspire.sir.module:announcements:2.3.1
channelscom.bitaspire.sir.module:channels:2.3.1
cooldownscom.bitaspire.sir.module:cooldowns:2.3.1
discordcom.bitaspire.sir.module:discord:2.3.1
emojiscom.bitaspire.sir.module:emojis:2.3.1
join-quitcom.bitaspire.sir.module:join-quit:2.3.1
logincom.bitaspire.sir.module:login:2.3.1
mentionscom.bitaspire.sir.module:mentions:2.3.1
moderationcom.bitaspire.sir.module:moderation:2.3.1
motdcom.bitaspire.sir.module:motd:2.3.1
tagscom.bitaspire.sir.module:tags:2.3.1
vanishcom.bitaspire.sir.module:vanish:2.3.1

Module aggregate POM

com.bitaspire.sir.module:all:2.3.1 is a POM-only aggregate that pulls in all module artifacts.

dependencies {
    implementation("com.bitaspire.sir.module:all:$sirVersion@pom")
}
<dependency>
  <groupId>com.bitaspire.sir.module</groupId>
  <artifactId>all</artifactId>
  <version>2.3.1</version>
  <type>pom</type>
</dependency>

Published command artifacts

The workflow publishes each command-provider jar under com.bitaspire.sir.command.

val sirVersion = "2.3.1"

repositories {
    maven("https://croabeast.github.io/repo/")
}

dependencies {
    implementation("com.bitaspire.sir.command:message:$sirVersion")
    implementation("com.bitaspire.sir.command:mute:$sirVersion")
}
ArtifactCoordinate
clear-chatcom.bitaspire.sir.command:clear-chat:2.3.1
colorcom.bitaspire.sir.command:color:2.3.1
ignorecom.bitaspire.sir.command:ignore:2.3.1
messagecom.bitaspire.sir.command:message:2.3.1
mutecom.bitaspire.sir.command:mute:2.3.1
nickcom.bitaspire.sir.command:nick:2.3.1
printcom.bitaspire.sir.command:print:2.3.1
settingscom.bitaspire.sir.command:settings:2.3.1

Command aggregate POM

com.bitaspire.sir.command:all:2.3.1 is a POM-only aggregate that pulls in all command-provider artifacts.

dependencies {
    implementation("com.bitaspire.sir.command:all:$sirVersion@pom")
}
<dependency>
  <groupId>com.bitaspire.sir.command</groupId>
  <artifactId>all</artifactId>
  <version>2.3.1</version>
  <type>pom</type>
</dependency>

Last updated on

On this page