Setup workflows for CF pages (#13)

* Setup workflows for CF pages * Copy javadoc to html subfolder * Also trigger on push for main deploy * Setup new action for specific brances * Stuff * Different ref name for push actin * Differnt name? * Right, nothing in these folders changed * Prod docs would get updated * Update some docs * Add workflow dispatch to be safe
lavalink-devs · Dec 17, 2023 · 26e789b · 26e789b
1 parent 64f8b44
commit 26e789b
Show file tree

Hide file tree

Showing 5 changed files with 97 additions and 1 deletion.
diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml
@@ -0,0 +1,45 @@
+name: Docs PR
+
+on:
+    pull_request_target:
+        branches: [ '**' ]
+        paths:
+            - 'dokka/**'
+            - 'src/main/**'
+            - '.github/workflows/docs-pr.yml'
+
+concurrency:
+    group: pages
+    cancel-in-progress: true
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            deployments: write
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  ref: "${{ github.event.pull_request.merge_commit_sha }}"
+                  fetch-depth: 0
+            - uses: actions/setup-java@v4
+              with:
+                java-version: 17
+                distribution: zulu
+                cache: gradle
+            -   name: Build docs
+                run: ./gradlew --no-daemon dokkaHtml dokkaJavadoc
+            - name: Copy javadoc subfolder
+              run: mv build/dokka/javadoc build/dokka/html/
+            - uses: actions/upload-pages-artifact@v1
+              with:
+                  path: 'build/dokka/html'
+            - uses: cloudflare/pages-action@v1
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
+                  directory: build/dokka/html
+                  branch: pr-${{ github.event.pull_request.number }}
+                  gitHubToken: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,41 @@
+name: Docs Push
+
+on:
+    release:
+        types: [ published ]
+    workflow_dispatch: {}
+
+concurrency:
+    group: pages-${{ github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            deployments: write
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+            - uses: actions/setup-java@v4
+              with:
+                  java-version: 17
+                  distribution: zulu
+                  cache: gradle
+            -   name: Build docs
+                run: ./gradlew --no-daemon dokkaHtml dokkaJavadoc
+            - name: Copy javadoc subfolder
+              run: mv build/dokka/javadoc build/dokka/html/
+            - uses: actions/upload-pages-artifact@v1
+              with:
+                  path: 'build/dokka/html'
+            - uses: cloudflare/pages-action@v1
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
+                  directory: build/dokka/html
+                  gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+                  wranglerVersion: '3'
diff --git a/README.md b/README.md
@@ -16,7 +16,11 @@ Feature overview:
 
 Current version (remove the `v` prefix): ![Latest version][VERSION]
 
-Or copy/download it [here](https://maven.arbjerg.dev/#/snapshots/dev/arbjerg/lavalink-client)
+Or copy/download it [here](https://maven.arbjerg.dev/#/releases/dev/arbjerg/lavalink-client)
+
+Documentation can be found over at [https://client.lavalink.dev/](https://client.lavalink.dev/)
+
+If you prefer javadoc-style documentation, you can find those [here](https://client.lavalink.dev/javadoc/)
 
 ### Gradle instructions
 ```gradle

diff --git a/src/main/kotlin/dev/arbjerg/lavalink/client/LavalinkNode.kt b/src/main/kotlin/dev/arbjerg/lavalink/client/LavalinkNode.kt
@@ -31,6 +31,9 @@ import java.net.URI
 import java.util.function.Consumer
 import java.util.function.UnaryOperator
 
+/**
+ * The Node is a physical instance of the lavalink server software.
+ */
 class LavalinkNode(
     val name: String,
     serverUri: URI,

diff --git a/src/main/kotlin/dev/arbjerg/lavalink/client/LavalinkPlayer.kt b/src/main/kotlin/dev/arbjerg/lavalink/client/LavalinkPlayer.kt
@@ -8,6 +8,9 @@ import dev.arbjerg.lavalink.protocol.v4.PlayerState
 import dev.arbjerg.lavalink.protocol.v4.VoiceState
 import kotlin.math.min
 
+/**
+ * Represents a player that is tied to a guild.
+ */
 class LavalinkPlayer(private val node: LavalinkNode, protocolPlayer: Player) : IUpdatablePlayer {
     val guildId = protocolPlayer.guildId.toLong()