Merge pull request #15 from respawn-app/1.4.0

1.4.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: Bug report
+about: Report a bug or an issue with existing features
+title: "[\U0001F41E] "
+labels: bug, triage
+assignees: Nek-12
+
+---
+
+### Description (required):
+
+<sup>describe the difference between expected and actual behavior, if not evident</sup>
+
+### Steps to reproduce (required)
+
+Steps to reproduce the behavior:
+
+1. ...
+
+---
+
+<details>
+  <summary>Stacktrace (if applicable):</summary>
+
+```plaintext
+
+```
+
+</details>
+
+---
+
+<details>
+  <summary>Relevant code:</summary>
+
+```kotlin
+
+```
+
+</details>
+
+---
+
+- [ ] This issue hasn't been reported already

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[\U0001F680] "
+labels: feature, triage
+assignees: Nek-12
+
+---
+
+### Description (required)
+
+<sup>describe what you are trying to solve and what is missing</sup>
+
+---
+
+<details>
+  <summary>Relevant code (if applicable):</summary>
+
+```kotlin
+
+```
+
+</details>
+
+---
+
+- [ ] This issue hasn't been reported already

.github/ISSUE_TEMPLATE/something-else.md

@@ -0,0 +1,13 @@
+---
+name: Something else
+about: Ask a question, request documentation, or something else
+title: "[❔] "
+labels: question, triage
+assignees: Nek-12
+
+---
+
+---
+
+- [ ] This question or issue hasn't been asked or reported already via Discussions or Issues
+- [ ] I have read the [documentation and FAQ](https://opensource.respawn.pro/FlowMVI/#/faq)

.github/changelog_config.json

@@ -0,0 +1,57 @@
+{
+  "template" : "#{{CHANGELOG}}",
+  "pr_template" : "- #{{TITLE_ONLY}}",
+  "trim_values" : true,
+  "categories" : [
+    {
+      "title" : "## 🚀 New Features",
+      "labels" : [
+        "feat",
+        "feature"
+      ]
+    },
+    {
+      "title" : "## 🧨 Api Changes",
+      "labels" : [
+        "feat!",
+        "breaking",
+        "api"
+      ]
+    },
+    {
+      "title" : "## 🐞 Bug Fixes",
+      "labels" : [
+        "fix",
+        "bug"
+      ]
+    },
+    {
+      "title" : "## ❔ Other",
+      "labels" : []
+    },
+    {
+      "title" : "## 📚 Docs",
+      "labels" : [
+        "doc",
+        "docs"
+      ]
+    }
+  ],
+  "custom_placeholders" : [
+    {
+      "name" : "TITLE_ONLY",
+      "source" : "TITLE",
+      "transformer" : {
+        "method" : "regexr",
+        "pattern" : "(\\w+(\\(.+\\))?: ?)?(.+)",
+        "target" : "$2"
+      }
+    }
+  ],
+  "label_extractor" : [
+    {
+      "pattern" : "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\\([\\w\\-\\.]+\\))?(!)?: ([\\w ])+([\\s\\S]*)",
+      "target" : "$1"
+    }
+  ]
+}

.github/ci-gradle.properties

@@ -1,6 +1,9 @@
-org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 -XX:+UseParallelGC
+org.gradle.jvmargs=-Xmx3g -Xms1g -XX:+UseParallelGC -XX:+UseStringDeduplication -Dfile.encoding=UTF-8
+kotlin.daemon.jvmargs=-Xmx3g -Xms1g -XX:+UseParallelGC -XX:+UseStringDeduplication -XX:MaxMetaspaceSize=1g
 android.useAndroidX=true
 kotlin.code.style=official
+org.gradle.caching=true
+org.gradle.parallel=true
 android.enableR8.fullMode=true
 org.gradle.configureondemand=true
 android.enableJetifier=false
@@ -10,15 +13,16 @@ android.experimental.enableSourceSetPathsMap=true
 android.experimental.cacheCompileLibResources=true
 kotlin.mpp.enableCInteropCommonization=true
 kotlin.mpp.stability.nowarn=true
-kotlin.mpp.androidSourceSetLayoutVersion=2
-android.nonFinalResIds=true
 kotlin.mpp.androidGradlePluginCompatibility.nowarn=true
-# changed
-org.gradle.caching=true
-org.gradle.parallel=true
-warningsAsErrors=true
-org.gradle.daemon=false
-org.gradle.workers.max=2
-org.gradle.unsafe.configuration-cache=false
+org.gradle.unsafe.configuration-cache=true
+kotlin.mpp.androidSourceSetLayoutVersion=2
 android.disableResourceValidation=false
+org.gradle.daemon=true
+android.nonFinalResIds=true
+kotlin.native.ignoreIncorrectDependencies=true
 kotlinx.atomicfu.enableJvmIrTransformation=true
+org.jetbrains.compose.experimental.macos.enabled=true
+org.gradle.configuration-cache.problems=warn
+nl.littlerobots.vcu.resolver=true
+org.gradle.console=plain
+CI=true

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/assign_self.yml

@@ -0,0 +1,16 @@
+name: Assign self to PR
+
+on:
+  pull_request:
+    types: [ opened ]
+    branches:
+      - master
+      - main
+
+jobs:
+  assign_author:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: samspills/[email protected]
+        with:
+          repo-token: '${{ secrets.GITHUB_TOKEN }}'

.github/workflows/autotag.yml

@@ -0,0 +1,27 @@
+name: Auto-tag
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - master
+
+jobs:
+  build:
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'autorelease')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.merge_commit_sha }}
+          fetch-depth: '0'
+
+      - name: Bump version and push tag
+        uses: anothrNick/github-tag-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.OPENSOURCE_PAT }} # Use PAT to trigger workflows
+          CUSTOM_TAG: ${{ github.event.pull_request.title }}
+          WITH_V: false
+          PRERELEASE: false

.github/workflows/ci.yml

@@ -15,18 +15,13 @@ jobs:
     runs-on: macos-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
 
-      - name: Create local properties
-        env:
-          LOCAL_PROPERTIES: ${{ secrets.LOCAL_PROPERTIES }}
-        run: echo "$LOCAL_PROPERTIES" > local.properties
-
       - name: set up JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           check-latest: true
@@ -40,11 +35,16 @@ jobs:
         with:
           xcode-version: latest
 
+      - name: Create local properties
+        env:
+          LOCAL_PROPERTIES: ${{ secrets.LOCAL_PROPERTIES }}
+        run: echo "$LOCAL_PROPERTIES" > local.properties
+
       - name: Run detekt
         run: ./gradlew detektAll
 
       - name: Build
-        run: ./gradlew assemble --stacktrace
+        run: ./gradlew assemble --stacktrace --no-configuration-cache
 
       - name: Unit tests
-        run: ./gradlew allTests --stacktrace
+        run: ./gradlew allTests --stacktrace --no-configuration-cache

.github/workflows/docs.yml

@@ -19,13 +19,13 @@ jobs:
 
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
 
       - name: set up JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           check-latest: true
@@ -44,19 +44,19 @@ jobs:
         run: cp ./README.md ./docs/README.md
 
       - name: Generate docs
-        run: ./gradlew dokkaHtmlMultiModule --no-configuration-cache
+        run: ./gradlew :dokkaHtmlMultiModule --no-configuration-cache
 
       - name: Move docs to the parent docs dir
-        run: cp -r ./build/dokka ./docs/javadocs/
+        run: cp -r ./build/dokka/htmlMultiModule/ ./docs/javadocs/
 
       - name: Setup Pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v5
 
       - name: Upload pages
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: './docs/'
 
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -1,9 +1,15 @@
-name: publish
+name: Publish a new Release
 
 on:
   push:
     tags:
       - '1.*'
+  workflow_dispatch:
+    inputs:
+      tag:
+        required: true
+        type: string
+        description: 'Tag to use for the release and changelog'
 
 concurrency:
   group: "publish"
@@ -12,15 +18,16 @@ concurrency:
 jobs:
   publish:
     runs-on: macos-latest
+    environment: publishing
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
 
       - name: set up JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           check-latest: true
@@ -43,4 +50,27 @@ jobs:
         env:
           ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.SIGNING_PASSWORD }}
           ORG_GRADLE_PROJECT_signingKey: ${{ secrets.SIGNING_KEY }}
-        run: ./gradlew publishAllPublicationsToSonatypeRepository --stacktrace -Dorg.gradle.workers.max=1
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+        # It's important to not upload in parallel or duplicate repos will be created
+        # repository creds are broken with gradle 8.6 https://github.com/gradle/gradle/issues/24040
+        run: ./gradlew publishAllPublicationsToSonatypeRepository -Dorg.gradle.parallel=false --stacktrace --no-configuration-cache
+
+      - name: Generate Changelog
+        uses: mikepenz/release-changelog-builder-action@v4
+        id: build_changelog
+        with:
+          commitMode: true
+          configuration: ./github/changelog_config.json
+
+      - name: Create GH release
+        uses: ncipollo/[email protected]
+        id: create_release
+        with:
+          draft: true
+          artifactErrorsFailBuild: false
+          prerelease: false
+          body: ${{steps.build_changelog.outputs.changelog}}
+          tag: ${{ inputs.tag != '' && inputs.tag || github.ref_name }}
+        env:
+          GITHUB_TOKEN: ${{ github.token }}