chore: start implementation on github actions

Author: simschla

.github/renovate.json5

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended",
+  ],
+  "packageRules": [
+  ]
+}

.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+---
+name: "ci_checks"
+"on":
+  pull_request: null
+  push:
+    branches:
+      - "main"
+      - "initial-version"
+  workflow_dispatch: null
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+jobs:
+  gradleCheck:
+    name: "run checks using gradlew"
+    runs-on: "ubuntu-latest"
+    env:
+      SEGMENT_DOWNLOAD_TIMEOUT_MINS: "15"
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 0
+      - name: "Install JDK 21"
+        uses: "actions/setup-java@v4"
+        with:
+          distribution: "graalvm"
+          java-version: 21
+      - name: "Install Node.js"
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: "Setup Gradle"
+        uses: "gradle/actions/setup-gradle@v4"
+      - name: "Run check on build-logic subproject"
+        run: "./gradlew :build-logic:check --no-configuration-cache"
+      - name: "Make sure usage files are up to date"
+        run: "./gradlew generateUsage"
+      - name: "Run check on project"
+        run: "./gradlew check"
+      - name: "junit result"
+        uses: "mikepenz/action-junit-report@v4"
+        if: "always()"
+        with:
+          check_name: "JUnit Report"
+          report_paths: "**/build/test-results/test/*.xml"
+  nativeCompile:
+    name: "run nativeCompile on relevant platforms"
+    needs: "gradleCheck"
+    strategy:
+      matrix:
+        runner:
+          - "ubuntu-latest"
+          - "ubuntu-24.04-arm"
+          - "windows-latest"
+          - "macos-latest"
+          - "macos-13"
+      fail-fast: false
+    runs-on: "${{ matrix.runner }}"
+    env:
+      SEGMENT_DOWNLOAD_TIMEOUT_MINS: "15"
+      BUILDCACHE_LOCAL_DEFAULT_DIRECTORY: "true"
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 0
+      - name: "Install JDK 21"
+        uses: "actions/setup-java@v4"
+        with:
+          distribution: "graalvm"
+          java-version: 21
+      - name: "Install Node.js"
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: "Setup Gradle"
+        uses: "gradle/actions/setup-gradle@v4"
+      - name: "Run gradle build"
+        run: "./gradlew nativeCompile"
+      - name: "Check if binary works"
+        run: "./gradlew testCliNative testCliNativeNpm"
+      - name: "junit result"
+        uses: "mikepenz/action-junit-report@v4"
+        if: "always()"
+        with:
+          check_name: "JUnit Report"
+          report_paths: "**/build/test-results/test/*.xml"

README.md

@@ -20,7 +20,7 @@ output = [
 
 <!---freshmark /shields -->
 
-> [!NOTE]\
+> [!NOTE]
 > This project is a work in progress :hourglass_flowing_sand: and not yet released.
 >
 > Please check back later for the first release. :heart:
@@ -92,12 +92,12 @@ This will show you the available options and formatters as such:
 
 <!---freshmark usage_main
 output =
-   '```shell\n' +
+   '```\n' +
    {{usage.main.array}}.join('\n') +
     '\n```';
 -->
 
-```shell
+```
                      __  __
    _________  ____  / /_/ /__  __________
   / ___/ __ \/ __ \/ __/ / _ \/ ___/ ___/
@@ -162,12 +162,12 @@ To see usage instructions for the google-java-format formatter, run: `spotless g
 
 <!---freshmark usage_google_java_format
 output =
-   '```shell\n' +
+   '```\n' +
    {{usage.google-java-format.array}}.join('\n') +
     '\n```';
 -->
 
-```shell
+```
 Usage: spotless google-java-format [-hijrV] [-s=<style>]
 Runs google java format
   -h, --help              Show this help message and exit.
@@ -200,12 +200,12 @@ To see usage instructions for the license-header formatter, run: `spotless licen
 
 <!---freshmark usage_license_header
 output =
-   '```shell\n' +
+   '```\n' +
    {{usage.license-header.array}}.join('\n') +
     '\n```';
 -->
 
-```shell
+```
 Usage: spotless license-header [-hV] [-c=<contentPattern>] [-d=<delimiter>]
                                [-m=<yearMode>] [-s=<skipLinesMatching>]
                                [-Y=<yearSeparator>] (-H=<header> |
@@ -261,12 +261,12 @@ To see usage instructions for the prettier formatter, run: `spotless prettier --
 
 <!---freshmark usage_prettier
 output =
-   '```shell\n' +
+   '```\n' +
    {{usage.prettier.array}}.join('\n') +
     '\n```';
 -->
 
-```shell
+```
 Usage: spotless prettier [-hV] [-C=<cacheDir>] [-n=<explicitNpmExecutable>]
                          [-N=<explicitNodeExecutable>]
                          [-P=<prettierConfigPath>] [-R=<explicitNpmrcFile>]

build-logic/src/main/groovy/buildlogic.spotless-json-conventions.gradle

@@ -0,0 +1,10 @@
+plugins {
+	id 'buildlogic.spotless-common-conventions'
+}
+
+spotless {
+	format 'json', {
+		target '.github/**/*.json', '*.json', 'src/**/*.json'
+		prettier()
+	}
+}

build-logic/src/main/groovy/buildlogic.spotless-yaml-conventions.gradle

@@ -0,0 +1,10 @@
+plugins {
+	id 'buildlogic.spotless-common-conventions'
+}
+
+spotless {
+	yaml {
+		target '.github/workflows/*.yml'
+		prettier()
+	}
+}

build.gradle

@@ -1,6 +1,8 @@
 plugins {
 	id 'buildlogic.spotless-gradle-conventions'
+	id 'buildlogic.spotless-json-conventions'
 	id 'buildlogic.spotless-markdown-conventions'
+	id 'buildlogic.spotless-yaml-conventions'
 	id 'buildlogic.changelog-conventions'
 }