Merge pull request #7 from ChafficPlugins/release/v0.0.1

release: prepare version 0.0.1

Author: Chafficui

.gitbook.yaml

@@ -0,0 +1,9 @@
+root: ./docs
+
+structure:
+  readme: README.md
+  summary: SUMMARY.md
+
+redirects:
+  guide/getting-started: ./guide/getting-started.md
+  api/overview: ./api/overview.md

.github/workflows/build.yml

@@ -10,10 +10,15 @@ permissions:
   contents: read
   checks: write
   pull-requests: write
+  pages: write
+  id-token: write
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - uses: actions/checkout@v4
 
@@ -45,18 +50,4 @@ jobs:
           fail_ci_if_error: false
 
       - name: Generate Documentation
-        run: ./gradlew dokkaHtml --no-daemon
-
-      - name: Archive documentation
-        uses: actions/upload-artifact@v4
-        with:
-          name: documentation
-          path: build/dokka/html/
-          retention-days: 14
-
-      - name: Check Code Coverage
-        run: |
-          ./gradlew jacocoTestCoverageVerification --no-daemon || {
-            echo "Code coverage is below 80%"
-            exit 1
-          }
+        run: ./gradlew dokkaHtml --no-daemon

.github/workflows/release.yml

@@ -54,9 +54,8 @@ jobs:
           draft: false
           prerelease: false
           files: |
-            build/libs/ChafficLib-${{ github.ref_name }}.jar
-            build/libs/ChafficLib-${{ github.ref_name }}-sources.jar
-            build/libs/ChafficLib-${{ github.ref_name }}-javadoc.jar
+            build/libs/ChafficLib-*.jar
+            !build/libs/ChafficLib-*-all.jar
           body_path: ${{ github.workspace }}/CHANGELOG.md
           generate_release_notes: true
 

CHANGELOG.md

@@ -7,21 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.1] - 2024-11-19
+
 ### Added
 - Initial project setup
 - CI/CD pipeline with GitHub Actions
 - Code coverage requirements (80% minimum)
 - Documentation generation with Dokka
+- Initial documentation structure with GitBook configuration
+- Getting started guide and installation instructions
+- API documentation placeholders for future content
 - Contribution guidelines
 - Version support documentation
-
-## [0.0.1] - 2024-01-17
-
-### Added
-- Basic project structure
-- Gradle build configuration
-- Testing framework setup
-- Initial documentation
+- Testing framework setup with JUnit 5 and MockBukkit
+- Test utilities for common testing scenarios
+- Example tests verifying framework functionality
+- Comprehensive test logging configuration
 
 [Unreleased]: https://github.com/chafficui/ChafficLib/compare/v0.0.1...HEAD
 [0.0.1]: https://github.com/chafficui/ChafficLib/releases/tag/v0.0.1

CONTRIBUTING.md

@@ -218,7 +218,7 @@ Format: `should_expectedBehavior_when_condition`
 Example: `should_throwException_when_inventoryIsFull`
 
 ### Coverage Requirements
-- Minimum 80% code coverage
+- Minimum 70% code coverage
 - 100% coverage for critical components
 - Test all edge cases
 - Include both positive and negative tests

README.md

@@ -78,7 +78,7 @@ We follow [Semantic Versioning](https://semver.org/). Check [VERSIONS.md](VERSIO
 5. Open a Pull Request
 
 ### Requirements for Pull Requests
-- 80% code coverage minimum
+- 70% code coverage minimum
 - Complete documentation for public APIs
 - Passing CI checks
 - Following our [coding standards](CONTRIBUTING.md)
@@ -91,5 +91,5 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 - 🌐 [Website](https://felixbeinssen.net)
 - 📚 [Documentation](https://chafficplugins.gitbook.io/chafficlib/)
-- 💬 [Discord](https://discord.gg/XXXXX)
+- 💬 [Discord](https://discord.gg/RPZBhB4rna)
 - 🐛 [Issue Tracker](https://github.com/chafficplugins/ChafficLib/issues)

VERSIONS.md

@@ -6,8 +6,7 @@ ChafficLib follows semantic versioning (MAJOR.MINOR.PATCH) and provides Long Ter
 
 | Version | Release Date | Support Status | Minecraft Versions | End of Life |
 |---------|--------------|----------------|-------------------|-------------|
-| 1.0.x   | 2025-Q2      | LTS            | 1.20.x - 1.21.x  | 2026-Q1     |
-| 0.0.x   | 2025-Q1      | Development    | 1.20.x - 1.21.x  | N/A         |
+| 0.0.x   | 2024-11-19   | Development    | 1.20.x - 1.21.x  | N/A         |
 
 ## Release Types
 
@@ -62,10 +61,8 @@ ChafficLib follows semantic versioning (MAJOR.MINOR.PATCH) and provides Long Ter
 
 ## Release Schedule 2024
 
-| Version | Type     | Release Date | EOL Date   |
-|---------|----------|--------------|------------|
-| 1.0.0   | LTS      | 2024-Q1     | 2025-Q1   |
-| 1.1.0   | Regular  | 2024-Q2     | 2024-Q3   |
-| 1.2.0   | Regular  | 2024-Q3     | 2024-Q4   |
-| 1.3.0   | Regular  | 2024-Q4     | 2025-Q1   |
-| 2.0.0   | LTS      | 2025-Q1     | 2026-Q1   |
+| Version | Type     | Release Date | EOL Date |
+|---------|----------|--------------|----------|
+| 0.1.0   | Regular  | 2024-Q4      | 2025-Q1  |
+| 0.2.0   | Regular  | 2025-Q1      | 2025-Q2  |
+| 1.0.0   | LTS      | 2025-Q2      | 2026-Q2  |

build.gradle.kts

@@ -16,6 +16,9 @@ repositories {
     maven("https://oss.sonatype.org/content/groups/public/") {
         name = "sonatype"
     }
+    maven("https://repo.papermc.io/repository/maven-public/") {
+        name = "papermc"
+    }
 }
 
 dependencies {
@@ -28,6 +31,7 @@ dependencies {
     testImplementation("com.github.seeseemelk:MockBukkit-v1.21:3.133.2")
     testImplementation("org.mockito.kotlin:mockito-kotlin:5.4.0")
     testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
+    testImplementation("io.papermc.paper:paper-api:1.21.3-R0.1-SNAPSHOT")
 }
 
 val targetJavaVersion = 21
@@ -36,9 +40,68 @@ kotlin {
 }
 
 tasks {
+    shadowJar {
+        archiveClassifier.set("")
+        archiveBaseName.set("ChafficLib")
+        archiveVersion.set(version.toString())
+    }
+
+    jar {
+        archiveBaseName.set("ChafficLib")
+        archiveVersion.set(version.toString())
+    }
+
+    javadoc {
+        options.encoding = "UTF-8"
+    }
+
+    register<Jar>("sourcesJar") {
+        archiveClassifier.set("sources")
+        from(sourceSets.main.get().allSource)
+    }
+
+    register<Jar>("javadocJar") {
+        dependsOn(javadoc)
+        archiveClassifier.set("javadoc")
+        from(javadoc.get().destinationDir)
+    }
+
+    build {
+        dependsOn(shadowJar)
+        dependsOn("sourcesJar")
+        dependsOn("javadocJar")
+        dependsOn(jacocoTestCoverageVerification)
+    }
+
     test {
         useJUnitPlatform()
         finalizedBy(jacocoTestReport)
+
+        testLogging {
+            events("PASSED", "SKIPPED", "FAILED", "STANDARD_OUT", "STANDARD_ERROR")
+
+            showExceptions = true
+            showCauses = true
+            showStackTraces = true
+
+            showStandardStreams = true
+
+            displayGranularity = 2
+
+            afterSuite(
+                KotlinClosure2({ desc: TestDescriptor, result: TestResult ->
+                    if (desc.parent == null) {
+                        println("\nTest result: ${result.resultType}")
+                        println(
+                            "Test summary: ${result.testCount} tests, " +
+                                "${result.successfulTestCount} succeeded, " +
+                                "${result.failedTestCount} failed, " +
+                                "${result.skippedTestCount} skipped",
+                        )
+                    }
+                }),
+            )
+        }
     }
 
     jacocoTestReport {
@@ -47,21 +110,38 @@ tasks {
             xml.required.set(true)
             html.required.set(true)
         }
+
+        classDirectories.setFrom(
+            files(
+                classDirectories.files.map {
+                    fileTree(it) {
+                        exclude("**/*\$Companion\$*.*")
+                    }
+                },
+            ),
+        )
     }
 
     jacocoTestCoverageVerification {
         violationRules {
             rule {
                 limit {
-                    minimum = "0.8".toBigDecimal()
+                    minimum = "0.7".toBigDecimal()
                 }
+                element = "CLASS"
+                excludes = listOf("*.Companion")
             }
-        }
-    }
 
-    build {
-        dependsOn(shadowJar)
-        dependsOn(jacocoTestCoverageVerification)
+            rule {
+                element = "METHOD"
+                excludes = listOf("@javax.annotation.Generated")
+            }
+
+            rule {
+                element = "METHOD"
+                excludes = listOf("*\$\$inlined*", "*\$Companion\$*")
+            }
+        }
     }
 
     dokkaHtml {

codecov.yml

@@ -2,11 +2,11 @@ coverage:
   status:
     project:
       default:
-        target: 80%
+        target: 70%
         threshold: 1%
     patch:
       default:
-        target: 80%
+        target: 70%
         threshold: 1%
 
 comment:

docs/README.md

@@ -0,0 +1,26 @@
+# ChafficLib Documentation
+
+Welcome to the ChafficLib documentation! This guide will help you get started with using ChafficLib in your Spigot plugins.
+
+## Quick Links
+
+- [Getting Started](guide/getting-started.md)
+- [API Reference](api/overview.md)
+- [GitHub Repository](https://github.com/chafficplugins/ChafficLib)
+
+## Features
+
+- 🎮 GUI System - Create intuitive inventory interfaces
+- ⚙️ Configuration System - Type-safe configuration handling
+- 💾 Database System - Easy database integration
+- 🛠️ Item System - Streamlined item creation
+- ✨ Effects System - Particle and sound effects
+- 📝 Event System - Simplified event handling
+- 🎯 Command System - Annotation-based commands
+
+## Support
+
+Need help? Check our:
+- [Discord Server](https://discord.gg/RPZBhB4rna)
+- [Issue Tracker](https://github.com/chafficplugins/ChafficLib/issues)
+- [API Documentation](api/overview.md)