Rewrite the build system. (#219)

This heavily relies on buildSrc and conventions to unify most of the build architecture. Versions are now externally defined via TOML file. Style is enforced via Spotless, but styling has not been applied to any files not touched by this commit. Documentation is now a gradle project with custom Jekyll build and serve tasks.
tudo-aqua · Feb 21, 2022 · f116916 · f116916
1 parent 1de0daa
commit f116916
Show file tree

Hide file tree

Showing 78 changed files with 1,811 additions and 1,202 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -6,10  6,10 @@ name: Build
 on:
   push:
     paths-ignore:
-      - 'docs/**'
       - 'bgw-docs/**'
   pull_request:
     paths-ignore:
-      - 'docs/**'
       - 'bgw-docs/**'
   workflow_dispatch:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel

diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -26,6  26,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
       - name: Copy docs to legacy location
         run: cp -r ./bgw-docs/src/main/jekyll ./docs
 
       - name: Set up JDK
         uses: actions/setup-java@v1
         with:

diff --git a/LICENSE-HEADER.txt b/LICENSE-HEADER.txt
diff --git a/bgw-docs/build.gradle.kts b/bgw-docs/build.gradle.kts
@@ -0,0  1,20 @@
 /*
  * Copyright 2021-2022 The BoardGameWork Authors
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 plugins { id("tools.aqua.bgw.jekyll-conventions") }
 
 dependencies { includedKDoc(project(":bgw-gui", "kdoc")) }
diff --git a/bgw-docs/src/main/jekyll/Gemfile b/bgw-docs/src/main/jekyll/Gemfile
@@ -0,0  1,2 @@
 source 'https://rubygems.org'
 gem 'github-pages', group: :jekyll_plugins
diff --git a/bgw-docs/src/main/jekyll/_config.yml b/bgw-docs/src/main/jekyll/_config.yml
@@ -0,0  1 @@
 remote_theme: pmarsceill/just-the-docs
diff --git a/docs/assets/game.png → bgw-docs/src/main/jekyll/assets/game.png b/docs/assets/game.png → bgw-docs/src/main/jekyll/assets/game.png
diff --git a/docs/assets/menu.png → bgw-docs/src/main/jekyll/assets/menu.png b/docs/assets/menu.png → bgw-docs/src/main/jekyll/assets/menu.png
diff --git a/docs/components/Components.md → .../src/main/jekyll/components/Components.md b/docs/components/Components.md → .../src/main/jekyll/components/Components.md
diff --git a/...components/componentview/componentview.md → ...components/componentview/componentview.md b/...components/componentview/componentview.md → ...components/componentview/componentview.md
diff --git a/docs/components/container/LinearLayout.png → ...yll/components/container/LinearLayout.png b/docs/components/container/LinearLayout.png → ...yll/components/container/LinearLayout.png
diff --git a/docs/components/container/container.md → .../jekyll/components/container/container.md b/docs/components/container/container.md → .../jekyll/components/container/container.md
diff --git a/.../dynamiccomponent/dynamiccomponentview.md → .../dynamiccomponent/dynamiccomponentview.md b/.../dynamiccomponent/dynamiccomponentview.md → .../dynamiccomponent/dynamiccomponentview.md
diff --git a/...mponents/gamecomponents/gamecomponents.md → ...mponents/gamecomponents/gamecomponents.md b/...mponents/gamecomponents/gamecomponents.md → ...mponents/gamecomponents/gamecomponents.md
diff --git a/docs/components/layout/layout.md → ...c/main/jekyll/components/layout/layout.md b/docs/components/layout/layout.md → ...c/main/jekyll/components/layout/layout.md
diff --git a/docs/components/uicomponents/Button.png → ...jekyll/components/uicomponents/Button.png b/docs/components/uicomponents/Button.png → ...jekyll/components/uicomponents/Button.png
diff --git a/docs/components/uicomponents/CheckBox.png → ...kyll/components/uicomponents/CheckBox.png b/docs/components/uicomponents/CheckBox.png → ...kyll/components/uicomponents/CheckBox.png
diff --git a/docs/components/uicomponents/ComboBox.png → ...kyll/components/uicomponents/ComboBox.png b/docs/components/uicomponents/ComboBox.png → ...kyll/components/uicomponents/ComboBox.png
diff --git a/docs/components/uicomponents/Label.png → .../jekyll/components/uicomponents/Label.png b/docs/components/uicomponents/Label.png → .../jekyll/components/uicomponents/Label.png
diff --git a/docs/components/uicomponents/TextArea.png → ...kyll/components/uicomponents/TextArea.png b/docs/components/uicomponents/TextArea.png → ...kyll/components/uicomponents/TextArea.png
diff --git a/.../components/uicomponents/ToggleButton.png → .../components/uicomponents/ToggleButton.png b/.../components/uicomponents/ToggleButton.png → .../components/uicomponents/ToggleButton.png
diff --git a/docs/components/uicomponents/TokenView.png → ...yll/components/uicomponents/TokenView.png b/docs/components/uicomponents/TokenView.png → ...yll/components/uicomponents/TokenView.png
diff --git a/docs/components/uicomponents/uicomponents.md → ...l/components/uicomponents/uicomponents.md b/docs/components/uicomponents/uicomponents.md → ...l/components/uicomponents/uicomponents.md
diff --git a/docs/components/uicomponents/visualguide.png → ...l/components/uicomponents/visualguide.png b/docs/components/uicomponents/visualguide.png → ...l/components/uicomponents/visualguide.png
diff --git a/docs/concepts/animations/Animations.md → .../jekyll/concepts/animations/Animations.md b/docs/concepts/animations/Animations.md → .../jekyll/concepts/animations/Animations.md
diff --git a/docs/concepts/animations/animations.gif → ...jekyll/concepts/animations/animations.gif b/docs/concepts/animations/animations.gif → ...jekyll/concepts/animations/animations.gif
diff --git a/docs/concepts/concepts.md → ...docs/src/main/jekyll/concepts/concepts.md b/docs/concepts/concepts.md → ...docs/src/main/jekyll/concepts/concepts.md
diff --git a/...cepts/drag-and-drop/DragAndDropExample.md → ...cepts/drag-and-drop/DragAndDropExample.md b/...cepts/drag-and-drop/DragAndDropExample.md → ...cepts/drag-and-drop/DragAndDropExample.md
diff --git a/docs/concepts/observable/observable.md → .../jekyll/concepts/observable/observable.md b/docs/concepts/observable/observable.md → .../jekyll/concepts/observable/observable.md
diff --git a/docs/concepts/user-input/UserInput.md → ...n/jekyll/concepts/user-input/UserInput.md b/docs/concepts/user-input/UserInput.md → ...n/jekyll/concepts/user-input/UserInput.md
diff --git a/docs/concepts/visual/card_deck.png → ...main/jekyll/concepts/visual/card_deck.png b/docs/concepts/visual/card_deck.png → ...main/jekyll/concepts/visual/card_deck.png
diff --git a/docs/concepts/visual/compounds.png → ...main/jekyll/concepts/visual/compounds.png b/docs/concepts/visual/compounds.png → ...main/jekyll/concepts/visual/compounds.png
diff --git a/docs/concepts/visual/visual.md → ...src/main/jekyll/concepts/visual/visual.md b/docs/concepts/visual/visual.md → ...src/main/jekyll/concepts/visual/visual.md
diff --git a/docs/dialogs/dialog/dialog.md → .../src/main/jekyll/dialogs/dialog/dialog.md b/docs/dialogs/dialog/dialog.md → .../src/main/jekyll/dialogs/dialog/dialog.md
diff --git a/docs/dialogs/dialog/exception_dialog.png → ...ekyll/dialogs/dialog/exception_dialog.png b/docs/dialogs/dialog/exception_dialog.png → ...ekyll/dialogs/dialog/exception_dialog.png
diff --git a/docs/dialogs/dialog/warning_dialog.png → .../jekyll/dialogs/dialog/warning_dialog.png b/docs/dialogs/dialog/warning_dialog.png → .../jekyll/dialogs/dialog/warning_dialog.png
diff --git a/docs/dialogs/dialogs.md → bgw-docs/src/main/jekyll/dialogs/dialogs.md b/docs/dialogs/dialogs.md → bgw-docs/src/main/jekyll/dialogs/dialogs.md
diff --git a/docs/dialogs/filedialog/filedialog.md → ...n/jekyll/dialogs/filedialog/filedialog.md b/docs/dialogs/filedialog/filedialog.md → ...n/jekyll/dialogs/filedialog/filedialog.md
diff --git a/docs/index.md → bgw-docs/src/main/jekyll/index.md b/docs/index.md → bgw-docs/src/main/jekyll/index.md
diff --git a/...til/bidirectional-map/bidirectionalmap.md → ...til/bidirectional-map/bidirectionalmap.md b/...til/bidirectional-map/bidirectionalmap.md → ...til/bidirectional-map/bidirectionalmap.md
diff --git a/docs/util/coordinate/coordinate.md → ...main/jekyll/util/coordinate/coordinate.md b/docs/util/coordinate/coordinate.md → ...main/jekyll/util/coordinate/coordinate.md
diff --git a/docs/util/stack/stack.md → bgw-docs/src/main/jekyll/util/stack/stack.md b/docs/util/stack/stack.md → bgw-docs/src/main/jekyll/util/stack/stack.md
diff --git a/docs/util/util.md → bgw-docs/src/main/jekyll/util/util.md b/docs/util/util.md → bgw-docs/src/main/jekyll/util/util.md
diff --git a/bgw-examples/bgw-docs-examples/build.gradle.kts b/bgw-examples/bgw-docs-examples/build.gradle.kts
@@ -1,25  1,29 @@
-@file:Suppress("SpellCheckingInspection")
 /*
  * Copyright 2022 The BoardGameWork Authors
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 plugins { id("tools.aqua.bgw.executable-conventions") }
 
-plugins {
-    kotlin("jvm")
-}
-
-group = "tools.aqua"
-version = rootProject.version
-
-repositories {
-    mavenCentral()
 mavenMetadata {
   name.set("BoardGameWork Docs Examples")
   description.set("The BGW documentation examples.")
 }
 
 dependencies {
-    implementation(kotlin("stdlib-jdk8"))
-    implementation(project(":bgw-gui"))
-    implementation(project(":bgw-net:bgw-net-common"))
-    implementation(project(":bgw-net:bgw-net-client"))
   implementation(project(":bgw-gui"))
   implementation(project(":bgw-net:bgw-net-client"))
   implementation(project(":bgw-net:bgw-net-common"))
 }
-
-tasks.withType<KotlinCompile> {
-    kotlinOptions.jvmTarget = "11"
-}
diff --git a/bgw-examples/bgw-maumau-example/build.gradle.kts b/bgw-examples/bgw-maumau-example/build.gradle.kts
@@ -1,25  1,31 @@
-@file:Suppress("SpellCheckingInspection")
 /*
  * Copyright 2022 The BoardGameWork Authors
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 plugins { id("tools.aqua.bgw.executable-conventions") }
 
-plugins {
-	kotlin("jvm")
-}
-
-group = "tools.aqua"
-version = rootProject.version
-
-repositories {
-	mavenCentral()
 mavenMetadata {
   name.set("BoardGameWork MauMau Example")
   description.set("The BGW MauMau example.")
 }
 
 dependencies {
-	implementation(kotlin("stdlib-jdk8"))
-	implementation(project(":bgw-gui"))
-	implementation(project(":bgw-net:bgw-net-common"))
-	implementation(project(":bgw-net:bgw-net-client"))
   implementation(project(":bgw-gui"))
   implementation(project(":bgw-net:bgw-net-client"))
   implementation(project(":bgw-net:bgw-net-common"))
 }
 
-tasks.withType<KotlinCompile> {
-	kotlinOptions.jvmTarget = "11"
-}
 application { mainClass.set("tools.aqua.bgw.examples.maumau.main.MainKt") }
diff --git a/bgw-examples/bgw-sudoku-example/build.gradle.kts b/bgw-examples/bgw-sudoku-example/build.gradle.kts
@@ -1,23  1,27 @@
-@file:Suppress("SpellCheckingInspection")
 /*
  * Copyright 2022 The BoardGameWork Authors
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 plugins { id("tools.aqua.bgw.executable-conventions") }
 
-plugins {
-	kotlin("jvm")
 mavenMetadata {
   name.set("BoardGameWork Sudoku Example")
   description.set("The BGW Sudoku example.")
 }
 
-group = "tools.aqua"
-version = rootProject.version
 dependencies { implementation(project(":bgw-gui")) }
 
-repositories {
-	mavenCentral()
-}
-
-dependencies {
-	implementation(kotlin("stdlib-jdk8"))
-	implementation(project(":bgw-gui"))
-}
-
-tasks.withType<KotlinCompile> {
-	kotlinOptions.jvmTarget = "11"
-}
 application { mainClass.set("tools.aqua.bgw.examples.sudoku.main.MainKt") }
diff --git a/bgw-examples/bgw-tetris-example/build.gradle.kts b/bgw-examples/bgw-tetris-example/build.gradle.kts
@@ -1,23  1,27 @@
-@file:Suppress("SpellCheckingInspection")
 /*
  * Copyright 2022 The BoardGameWork Authors
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 plugins { id("tools.aqua.bgw.executable-conventions") }
 
-plugins {
-	kotlin("jvm")
 mavenMetadata {
   name.set("BoardGameWork Tetris Example")
   description.set("The BGW Tetris example.")
 }
 
-group = "tools.aqua"
-version = rootProject.version
 dependencies { implementation(project(":bgw-gui")) }
 
-repositories {
-	mavenCentral()
-}
-
-dependencies {
-	implementation(kotlin("stdlib-jdk8"))
-	implementation(project(":bgw-gui"))
-}
-
-tasks.withType<KotlinCompile> {
-	kotlinOptions.jvmTarget = "11"
-}
 application { mainClass.set("tools.aqua.bgw.examples.tetris.main.MainKt") }
Original file line number	Diff line number	Diff line change
		@@ -0,0 1,2 @@
		source 'https://rubygems.org'
		gem 'github-pages', group: :jekyll_plugins