Merge pull request #9 from litetex-oss/dev

litetex · web-flow · commit 5c356ab1a78e · 2025-03-12T21:56:06.000+01:00
Release
diff --git a/.github/workflows/check-build.yml b/.github/workflows/check-build.yml
@@ -24,7 +24,7 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-
+    timeout-minutes: 10
     strategy:
       matrix:
         java: [21]
@@ -41,7 +41,7 @@ jobs:
         cache: 'gradle'
       
     - name: Build
-      run: ./gradlew build --info
+      run: ./gradlew build --info --stacktrace
       
     - name: Check for uncommited changes
       run: |
@@ -65,13 +65,17 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: mod-files-java-${{ matrix.java }}
-        path: build/libs/*.jar
+        path: |
+          build/devlibs/*-sources.jar
+          build/libs/*.jar
+          !build/libs/*-sources.jar
+          !build/libs/*-javadoc.jar
         if-no-files-found: error
 
   code-style:
     runs-on: ubuntu-latest
     if: ${{ github.event_name != 'pull_request' || !(startsWith(github.head_ref, 'renovate/') || startsWith(github.head_ref, 'automated/')) }}
-
+    timeout-minutes: 10
     strategy:
       matrix:
         java: [21]
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -9,8 +9,9 @@ permissions:
   pull-requests: write
 
 jobs:
-  check_code: # Validates the code
+  check_code:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
     - uses: actions/checkout@v4
       
@@ -45,6 +46,7 @@ jobs:
   prepare_release:
     runs-on: ubuntu-latest
     needs: [check_code]
+    timeout-minutes: 10
     outputs:
       upload_url: ${{ steps.create_release.outputs.upload_url }}
     steps:
@@ -98,11 +100,12 @@ jobs:
           ## Installation
           The mod can be downloaded from [Modrinth](https://modrinth.com/mod/${{ steps.metadata.outputs.archives_base_name }}).
 
-          Alternatively you can also download the mod from the release assets below.
+          Alternatively you can also download the mod from the release assets below or from [Maven Central](https://repo.maven.apache.org/maven2/net/litetex/mcm/).
 
   publish:
     runs-on: ubuntu-latest
     needs: [prepare_release]
+    timeout-minutes: 60
     steps:
     - uses: actions/checkout@v4
     
@@ -120,7 +123,7 @@ jobs:
         git pull
     
     - name: Build and publish
-      run: ./gradlew clean build modrinth --info
+      run: ./gradlew clean build modrinth --info --stacktrace
       env:
         MODRINTH_TOKEN:  ${{ secrets.MODRINTH_TOKEN }}
         MODRINTH_CHANGELOG_TEXT: 'Available at https://github.com/litetex-oss/mcm-cape-provider/blob/dev/CHANGELOG.md'
@@ -129,11 +132,24 @@ jobs:
       uses: shogo82148/actions-upload-release-asset@v1
       with:
         upload_url: ${{ needs.prepare_release.outputs.upload_url }}
-        asset_path: build/libs/*.jar
+        asset_path: |
+          build/devlibs/*-sources.jar
+          build/libs/*.jar
+          !build/libs/*-sources.jar
+          !build/libs/*-javadoc.jar
+    
+    - name: Publish to OSSRH
+      run: ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository --info --stacktrace
+      env:
+        MAVEN_GPG_PRIVATE_KEY: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
+        MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+        S01_OSS_SONATYPE_MAVEN_USERNAME: ${{ secrets.S01_OSS_SONATYPE_MAVEN_USERNAME }}
+        S01_OSS_SONATYPE_MAVEN_TOKEN: ${{ secrets.S01_OSS_SONATYPE_MAVEN_TOKEN }}
 
   after_release:
     runs-on: ubuntu-latest
     needs: [publish]
+    timeout-minutes: 10
     steps:
     - uses: actions/checkout@v4
       
diff --git a/.github/workflows/sonar.yml b/.github/workflows/sonar.yml
@@ -30,6 +30,7 @@ jobs:
     name: SonarCloud Scan
     runs-on: ubuntu-latest
     if: ${{ github.event_name != 'pull_request' || !(startsWith(github.head_ref, 'renovate/') || startsWith(github.head_ref, 'automated/')) }}
+    timeout-minutes: 15
     steps:
       - uses: actions/checkout@v4
         with:
diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml
@@ -6,6 +6,7 @@ on:
 jobs:
   publish:
     runs-on: ubuntu-latest
+    timeout-minutes: 60
     steps:
     - uses: actions/checkout@v4
     
@@ -15,9 +16,9 @@ jobs:
         distribution: 'temurin'
         java-version: '21'
         cache: 'gradle'
-
+    
     - name: Build and publish
-      run: ./gradlew clean build modrinth --info
+      run: ./gradlew clean build modrinth --info --stacktrace
       env:
         MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }}
         MODRINTH_VERSION_TYPE: 'alpha'
@@ -27,5 +28,17 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: mod-files
-        path: build/libs/*.jar
+        path: |
+          build/devlibs/*-sources.jar
+          build/libs/*.jar
+          !build/libs/*-sources.jar
+          !build/libs/*-javadoc.jar
         if-no-files-found: error
+    
+    - name: Publish to OSSRH
+      run: ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository --info --stacktrace
+      env:
+        MAVEN_GPG_PRIVATE_KEY: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
+        MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+        S01_OSS_SONATYPE_MAVEN_USERNAME: ${{ secrets.S01_OSS_SONATYPE_MAVEN_USERNAME }}
+        S01_OSS_SONATYPE_MAVEN_TOKEN: ${{ secrets.S01_OSS_SONATYPE_MAVEN_TOKEN }}
diff --git a/.github/workflows/update-yarn.yml b/.github/workflows/update-yarn.yml
@@ -15,7 +15,7 @@ env:
 jobs:
   update:
     runs-on: ubuntu-latest
-
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
         with:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+# 1.0.2
+* Distribute mod on Maven Central
+
 # 1.0.1
 * Improved compatibility information
 
diff --git a/PROGRAMMATIC_PROVIDER.md b/PROGRAMMATIC_PROVIDER.md
@@ -0,0 +1,55 @@
+# Creating a custom programmatic cape provider
+
+> [!NOTE]
+> This is more complex and some Java coding experience is required.
+
+You can also add a custom cape provider programmatically using [Java's Service Loading](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/ServiceLoader.html).
+
+To achieve the same as in the example [from the Readme](./README.md) do the following:
+
+1. Create a new (fabric) mod
+2. Add the mod as a dependency:
+    ``build.gradle``
+    ```groovy
+    dependencies {
+        modImplementation 'net.litetex.mcm:cape-provider:<version>'
+    }
+    ```
+3. Create a custom provider:
+    ``src/main/java/com/example/capes/provider/MyCustomCapeProvider.java``
+    ```java
+    public class MyCustomCapeProvider implements CapeProvider
+    {
+        @Override
+        public String id() {
+            return "cp";
+        }
+
+        @Override
+        public String name() {
+            return "Custom Provider";
+        }
+
+        @Override
+        public String getBaseUrl(GameProfile profile) {
+            return "https://raw.githubusercontent.com/litetex-oss/mcm-cape-provider/refs/heads/dev/custom-cape-demo/uuid.png";
+        }
+
+        // You can add more custom code here
+    }
+    ```
+4. Register the provider
+    ``src/main/resources/META-INF/services/net.litetex.capes.provider.CapeProvider``
+    ```
+    com.example.capes.provider.MyCustomCapeProvider
+    ```
+5. (Optional) Declare that your mod needs Cape Provider
+    ``src/main/resources/fabric.mod.json``
+    ```jsonc
+      // ...
+      "recommends": { // You can also use "depends"
+        "cape-provider": "*" // Or add the corresponding version
+      }
+      // ...
+    ```
+    You might also have to declare this in other places (e.g. on Modrinth).
diff --git a/README.md b/README.md
@@ -41,11 +41,27 @@ This demo showcases how to apply the capes inside [``custom-cape-demo``](https:/
 
 For more details have a look at [CustomProvider](https://github.com/litetex-oss/mcm-cape-provider/tree/dev/src/main/java/net/litetex/capes/provider/CustomProvider.java) and [CustomProviderConfig](https://github.com/litetex-oss/mcm-cape-provider/tree/dev/src/main/java/net/litetex/capes/config/CustomProviderConfig.java)
 
+You can also create a [programmatic cape provider](https://github.com/litetex-oss/mcm-cape-provider/tree/dev/PROGRAMMATIC_PROVIDER.md).
+
 <!-- modrinth_exclude.start -->
 
 ## Installation
 [Installation guide for the latest release](https://github.com/litetex-oss/mcm-cape-provider/releases/latest#Installation)
 
+### Usage in other mods
+
+Add the following to ``build.gradle``:
+```groovy
+dependencies {
+    modImplementation 'net.litetex.mcm:cape-provider:<version>'
+    // Further documentation: https://wiki.fabricmc.net/documentation:fabric_loom
+}
+```
+
+> [!NOTE]
+> No dedicated repository is required as the content are hosted on [Maven Central](https://maven.apache.org/repository/).<br/>
+> If this somehow shouldn't work you can also try [Modrinth Maven](https://support.modrinth.com/en/articles/8801191-modrinth-maven).
+
 ## Contributing
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
diff --git a/build.gradle b/build.gradle
diff --git a/gradle.properties b/gradle.properties
diff --git a/renovate.json5 b/renovate.json5
diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json

-Original file line number
+Diff line change
@@ @@ -1,3 +1,6 @@ @@
 +# 1.0.2
 +* Distribute mod on Maven Central
++
 # 1.0.1
 * Improved compatibility information