Merge pull request #53 from teogor/release/1.0.0-beta02

Prepare `winds` 1.0.0-beta02 release
teogor · Feb 19, 2024 · 1f0a1b7 · 1f0a1b7
2 parents 9252a1c + a4b39f8
commit 1f0a1b7
Show file tree

Hide file tree

Showing 8 changed files with 72 additions and 37 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -27,6 +27,7 @@ env:
 
 jobs:
   synchronize-documentation:
+    environment: PRODUCTION
     runs-on: ubuntu-latest
     name: Synchronize Repository Documentation
     steps:
@@ -63,8 +64,8 @@ jobs:
 
       - name: Relocate API References
         run: |
-          mkdir -p build/docs/${{ env.REPOSITORY }}/reference
-          cp -r build/dokka/htmlMultiModule/* build/docs/${{ env.REPOSITORY }}/reference
+          mkdir -p build/docs/${{ env.REPOSITORY }}/html
+          cp -r build/dokka/htmlMultiModule/* build/docs/${{ env.REPOSITORY }}/html
 
       - id: publish-docs
         name: Deploy Documentation
@@ -80,6 +81,7 @@ jobs:
           destination-branch-create: ${{ env.DESTINATION_BRANCH }}
 
   build-and-deploy:
+    environment: PRODUCTION
     needs: synchronize-documentation
     name: Build and Deploy Updated API Documentation
     runs-on: ubuntu-latest

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ To implement the Winds plugin, add the following plugin ID to your build.gradle
 
 ```kotlin
 plugins {
-  id "dev.teogor.winds" version "1.0.0-beta01"
+  id "dev.teogor.winds" version "1.0.0-beta02"
 }
 ```
 
@@ -45,7 +45,7 @@ library:
 
 ```kotlin
 plugins {
-  id "dev.teogor.winds" version "1.0.0-beta01"
+  id "dev.teogor.winds" version "1.0.0-beta02"
 }
 
 winds {

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -25,7 +25,7 @@ plugins {
 // Explicitly set the group and version for all subprojects
 subprojects {
   group = "dev.teogor.winds"
-  version = "1.0.0-beta01"
+  version = "1.0.0-beta02"
 }
 
 val ktlintVersion = "0.50.0"

diff --git a/docs/index.md b/docs/index.md
@@ -33,15 +33,15 @@ To implement the Winds plugin, add the following plugin ID to your build.gradle
 
     ```kotlin
     plugins {
-      id("dev.teogor.winds") version "1.0.0-beta01"
+      id("dev.teogor.winds") version "1.0.0-beta02"
     }
     ```
 
 === "Groovy"
 
     ```groovy
     plugins {
-      id 'dev.teogor.winds' version '1.0.0-beta01'
+      id 'dev.teogor.winds' version '1.0.0-beta02'
     }
     ```
 

diff --git a/docs/reference.md b/docs/reference.md
@@ -8,19 +8,15 @@ full potential.
 ### Project Overview
 
 Our project encompasses a suite of modules, each designed to address specific functionalities and
-enhance the overall developer experience. To delve into the intricacies of each module, refer to
-the dedicated documentation pages:
+enhance the overall developer experience. To delve into the intricacies of each module, refer to the
+dedicated documentation pages:
 
-- **[Winds 🔗](../reference):** Discover the heart of our project.
+### API Reference
 
-- **[API 🔗](../reference/api):** Navigate directly to the code-specific documentation for the
-  project's `:api` module
-
-- **[Common 🔗](../reference/common):** Navigate directly to the code-specific documentation for the
-  project's `:common` module
-
-- **[Plugin 🔗](../reference/gradle-plugin):** Navigate directly to the code-specific documentation
-  for the project's `:gradle-plugin` module
+* [`dev.teogor.winds`](../html/){:target="_blank"}
+* [`dev.teogor.winds:api`](../html/api){:target="_blank"}
+* [`dev.teogor.winds:common`](../html/common){:target="_blank"}
+* [`dev.teogor.winds:gradle-plugin`](../html/gradle-plugin){:target="_blank"}
 
 ### Contributions and Support
 

diff --git a/docs/releases.md b/docs/releases.md
@@ -8,15 +8,21 @@ Winds build and publish libraries and applications for multiple platforms, simpl
 
 ### API Reference
 
-* [`dev.teogor.winds`](../reference/gradle-plugin)
-* [`dev.teogor.winds:api`](../reference/api)
-* [`dev.teogor.winds:common`](../reference/common)
+* [`dev.teogor.winds`](../html/){:target="_blank"}
+* [`dev.teogor.winds:api`](../html/api){:target="_blank"}
+* [`dev.teogor.winds:common`](../html/common){:target="_blank"}
+* [`dev.teogor.winds:gradle-plugin`](../html/gradle-plugin){:target="_blank"}
 
 ### Release
 
 |   Latest Update   | Stable Release | Beta Release | Alpha Release |
 |:-----------------:|:--------------:|:------------:|:-------------:|
-| February 08, 2023 |       -        |      -       | 1.0.0-beta01  |
+| February 19, 2024 |       -        |      -       | 1.0.0-beta02  |
+| February 08, 2024 |       -        |      -       | 1.0.0-beta01  |
+| November 25, 2023 |       -        |      -       | 1.0.0-alpha04 |
+| November 20, 2023 |       -        |      -       | 1.0.0-alpha03 |
+| November 08, 2023 |       -        |      -       | 1.0.0-alpha02 |
+| November 06, 2023 |       -        |      -       | 1.0.0-alpha01 |
 
 ### Declaring dependencies
 
@@ -29,15 +35,15 @@ Add the dependencies for the artifacts you need in the `build.gradle` file for y
 
     ```kotlin
     plugins {
-      id("dev.teogor.winds") version "1.0.0-beta01"
+      id("dev.teogor.winds") version "1.0.0-beta02"
     }
     ```
 
 === "Groovy"
 
     ```groovy
     plugins {
-      id 'dev.teogor.winds' version '1.0.0-beta01'
+      id 'dev.teogor.winds' version '1.0.0-beta02'
     }
     ```
 
@@ -52,9 +58,28 @@ existing issue by clicking the star button.
 
 ### Version 1.0.0
 
+#### Version 1.0.0-beta02
+
+February 19, 2024
+
+`dev.teogor.winds:winds-*:1.0.0-beta02` is
+released. [Version 1.0.0-beta02 contains these commits.](https://github.com/teogor/winds/compare/1.0.0-beta01...1.0.0-beta02)
+
+**Enhancement**
+
+* Integrate `IssueManagement` interface and enable custom issue management in Maven
+  publications ([#52](https://github.com/teogor/winds/pull/52))
+  by [@teogor](https://github.com/teogor)
+* Integrate `Contributor` interface and enable custom contributors in Maven
+  publications ([#51](https://github.com/teogor/winds/pull/51))
+  by [@teogor](https://github.com/teogor)
+* Add option for unique names
+  using `enforceUniqueNames` ([#50](https://github.com/teogor/winds/pull/50))
+  by [@teogor](https://github.com/teogor)
+
 #### Version 1.0.0-beta01
 
-February 08, 2023
+February 08, 2024
 
 `dev.teogor.winds:winds-*:1.0.0-beta01` is
 released. [Version 1.0.0-beta01 contains these commits.](https://github.com/teogor/winds/compare/1.0.0-alpha04...1.0.0-beta01)

diff --git a/docs/releases/implementation.md b/docs/releases/implementation.md
@@ -4,14 +4,15 @@
 
 ### Latest Version
 
-The latest release is [`1.0.0-beta01`](../releases.md)
+The latest release is [`1.0.0-beta02`](../releases.md)
 
 ### Plugin Releases
 
 Here's a summary of the latest versions:
 
 |    Version    |               Release Notes                | Release Date |
 |:-------------:|:------------------------------------------:|:------------:|
+| 1.0.0-beta02  | [changelog 🔗](changelog/1.0.0-beta02.md)  | 19 Feb 2024  |
 | 1.0.0-beta01  | [changelog 🔗](changelog/1.0.0-beta01.md)  | 08 Feb 2024  |
 | 1.0.0-alpha04 | [changelog 🔗](changelog/1.0.0-alpha04.md) | 24 Nov 2023  |
 | 1.0.0-alpha03 | [changelog 🔗](changelog/1.0.0-alpha03.md) | 20 Nov 2023  |
@@ -29,41 +30,51 @@ TOML format.
 
     ```toml title="gradle/libs.versions.toml"
     [versions]
-    winds = "1.0.0-beta01"
+    teogor-winds = "1.0.0-beta02"
 
     [plugins]
-    winds = { id = "dev.teogor.winds", version.ref = "winds" }
+    teogor-winds = { id = "dev.teogor.winds", version.ref = "teogor-winds" }
     ```
 
 === "Using Plugin SDK"
 
     ```toml title="gradle/libs.versions.toml"
     [versions]
-    winds = "1.0.0-beta01"
+    teogor-winds = "1.0.0-beta02"
 
     [libraries]
-    winds-api = { group = "dev.teogor.winds", name = "api", version.ref = "winds" }
-    winds-common = { group = "dev.teogor.winds", name = "common", version.ref = "winds" }
+    teogor-winds-api = { module = "dev.teogor.winds:api", version.ref = "teogor-winds" }
+    teogor-winds-common = { module = "dev.teogor.winds:common", version.ref = "teogor-winds" }
     ```
 
 #### Dependencies Implementation
 
 === "Kotlin"
 
     ```kotlin title="build.gradle.kts"
+    plugins {
+      // Winds Plugin
+      alias(libs.plugins.teogor.winds)
+    }
+
     dependencies {
       // Winds Libraries
-      implementation(libs.winds.api)
-      implementation(libs.winds.common)
+      implementation(libs.teogor.winds.api)
+      implementation(libs.teogor.winds.common)
     }
     ```
 
 === "Groovy"
 
     ```groovy title="build.gradle"
+    plugins {
+      // Winds Plugin
+      alias(libs.plugins.teogor.winds)
+    }
+
     dependencies {
       // Winds Libraries
-      implementation(libs.winds.api)
-      implementation(libs.winds.common)
+      implementation(libs.teogor.winds.api)
+      implementation(libs.teogor.winds.common)
     }
     ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -3,7 +3,7 @@ site_description: Winds build and publish libraries and applications for multipl
 site_author: Teodor Grigor (teogor)
 site_dir: build/docs/winds
 site_url: https://github.com/teogor/winds
-edit_uri: raw/main/docs/
+edit_uri: edit/main/docs/
 
 docs_dir: docs
 
@@ -12,7 +12,7 @@ repo_name: winds
 repo_url: https://github.com/teogor/winds
 
 # Copyright
-copyright: Copyright &copy; 2023 Teodor Grigor (Teogor)
+copyright: Copyright &copy; 2024 Teodor Grigor (Teogor)
 
 # Page tree
 nav:
@@ -21,6 +21,7 @@ nav:
     - releases.md
     - Implementation: releases/implementation.md
     - Changelog:
+      - 1.0.0-beta02: releases/changelog/1.0.0-beta02.md
       - 1.0.0-beta01: releases/changelog/1.0.0-beta01.md
       - 1.0.0-alpha04: releases/changelog/1.0.0-alpha04.md
       - 1.0.0-alpha03: releases/changelog/1.0.0-alpha03.md