Initial commit

Author: AndreaGiulianelli

.gitattributes

@@ -0,0 +1,5 @@
+* text=auto eol=lf
+*.[cC][mM][dD] text eol=crlf
+*.[bB][aA][tT] text eol=crlf
+*.[pP][sS]1 text eol=crlf
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,17 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Insert a clear description in order to enable us to reproduce the bug.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEAT]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe your feature request**
+A clear and concise description of what the problem is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.

.github/workflows/build-and-deploy.yml

@@ -0,0 +1,146 @@
+name: Build & Deploy
+
+on:
+  push:
+    paths-ignore:
+      - '.gitignore'
+      - '.mergify.yml'
+      - 'CHANGELOG.md'
+      - 'LICENSE'
+      - 'README.md'
+      - 'renovate.json'
+  pull_request:
+
+jobs:
+  validation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - name: Validate the Gradle Wrapper
+        uses: gradle/[email protected]
+  build:
+    needs:
+      - validation
+    strategy:
+        matrix:
+          os: [ubuntu, macos, windows]
+          java-version: [11, 17]
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: adopt
+      - name: Run quality assurance and test with coverage
+        run: ./gradlew clean check
+      - name: CodeCov
+        uses: codecov/[email protected]
+        with:
+          directory: "build/reports/jacoco"
+  release:
+    concurrency:
+        # Allow only one release at a time.
+        group: release-${{ github.event.number || github.ref }}
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    outputs:
+      release-status: ${{ env.release_status }}
+      release-version: ${{ env.release_version }}
+    # Release only where secrets are available.
+    if: >-
+      !github.event.repository.fork
+      && (
+        github.event_name != 'pull_request'
+        || github.event.pull_request.head.repo.full_name == github.repository
+      )
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.DEPLOYMENT_TOKEN }}
+          submodules: recursive
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.DEPLOYMENT_TOKEN }}
+        run: |
+          npm install
+          npx semantic-release
+  docker-image-delivery:
+    needs:
+      - release
+    runs-on: ubuntu-latest
+    if: needs.release.outputs.release-status == 'released'
+    env:
+      REGISTRY: ghcr.io
+      IMAGE_NAME: ${{ github.repository }}
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Login to GitHub Container registry
+        uses: docker/[email protected]
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - id: full-image-name
+        run: echo "image-name=${{env.REGISTRY}}/${{env.IMAGE_NAME}}" | tr '[:upper:]' '[:lower:]' >> $GITHUB_OUTPUT
+      - name: Build and push the image to GitHub Container registry
+        uses: docker/[email protected]
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.full-image-name.outputs.image-name }}:latest, ${{ steps.full-image-name.outputs.image-name }}:${{ needs.release.outputs.release-version }}
+  documentation-deploy:
+    needs:
+      - release
+    runs-on: ubuntu-latest
+    # Update documentation only when there is a new release
+    if: needs.release.outputs.release-status == 'released'
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Generate Documentation
+        run: ./gradlew dokkaHtml
+      - name: Deploy documentation on GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          keep_files: true
+          publish_dir: ./build/dokka/html
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          commit_message: 'docs: update documentation'
+  success:
+    runs-on: ubuntu-22.04
+    needs:
+      - build
+      - release
+      - docker-image-delivery
+      - documentation-deploy
+    if: >-
+      always() && (
+        contains(join(needs.*.result, ','), 'failure')
+        || !contains(join(needs.*.result, ','), 'cancelled')
+      )
+    steps:
+      - name: Verify that there were no failures
+        run: ${{ !contains(join(needs.*.result, ','), 'failure') }}

.gitignore

@@ -0,0 +1,82 @@
+.DS_Store
+.idea/shelf
+/confluence/target
+/dependencies/repo
+/android.tests.dependencies
+/dependencies/android.tests.dependencies
+/dist
+/local
+/gh-pages
+/ideaSDK
+/clionSDK
+/android-studio/sdk
+out/
+/tmp
+/intellij
+workspace.xml
+*.versionsBackup
+/idea/testData/debugger/tinyApp/classes*
+/jps-plugin/testData/kannotator
+/js/js.translator/testData/out/
+/js/js.translator/testData/out-min/
+/js/js.translator/testData/out-pir/
+.gradle/
+build/
+bin/
+!**/src/**/build
+!**/test/**/build
+*.iml
+!**/testData/**/*.iml
+.idea/remote-targets.xml
+.idea/libraries/Gradle*.xml
+.idea/libraries/Maven*.xml
+.idea/artifacts/PILL_*.xml
+.idea/artifacts/KotlinPlugin.xml
+.idea/modules
+.idea/runConfigurations/JPS_*.xml
+.idea/runConfigurations/PILL_*.xml
+.idea/runConfigurations/_FP_*.xml
+.idea/runConfigurations/_MT_*.xml
+.idea/libraries
+.idea/modules.xml
+.idea/gradle.xml
+.idea/compiler.xml
+.idea/inspectionProfiles/profiles_settings.xml
+.idea/.name
+.idea/artifacts/dist_auto_*
+.idea/artifacts/dist.xml
+.idea/artifacts/ideaPlugin.xml
+.idea/artifacts/kotlinc.xml
+.idea/artifacts/kotlin_compiler_jar.xml
+.idea/artifacts/kotlin_plugin_jar.xml
+.idea/artifacts/kotlin_jps_plugin_jar.xml
+.idea/artifacts/kotlin_daemon_client_jar.xml
+.idea/artifacts/kotlin_imports_dumper_compiler_plugin_jar.xml
+.idea/artifacts/kotlin_main_kts_jar.xml
+.idea/artifacts/kotlin_compiler_client_embeddable_jar.xml
+.idea/artifacts/kotlin_reflect_jar.xml
+.idea/artifacts/kotlin_stdlib_js_ir_*
+.idea/artifacts/kotlin_test_js_ir_*
+.idea/artifacts/kotlin_stdlib_wasm_*
+.idea/artifacts/kotlinx_atomicfu_runtime_*
+.idea/artifacts/kotlinx_cli_jvm_*
+.idea/jarRepositories.xml
+.idea/csv-plugin.xml
+.idea/libraries-with-intellij-classes.xml
+.idea/misc.xml
+.idea/protoeditor.xml
+.idea/kotlinc.xml
+.idea/vcs.xml
+.idea/checkstyle-idea.xml
+.idea/git_toolbox_prj.xml
+node_modules/
+.rpt2_cache/
+libraries/tools/kotlin-test-js-runner/lib/
+local.properties
+buildSrcTmp/
+distTmp/
+outTmp/
+/test.output
+/kotlin-native/dist
+kotlin-ide/
+.vscode/*

.idea/codeStyles/Project.xml

@@ -0,0 +1,16 @@
+pull_request_rules:
+  - name: Automatic PR Update
+    conditions:
+      - check-success=success
+    actions:
+      update:
+  - name: rebase-merge working updates
+    conditions:
+      - author=renovate[bot]
+      - label=dependencies
+      - -draft
+      - -conflict
+      - check-success=success
+    actions:
+      merge:
+        method: rebase

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,40 @@
+## [0.1.1](https://github.com/SmartOperatingBlock/kotlin-template-project/compare/0.1.0...0.1.1) (2023-02-06)
+
+
+### General maintenance
+
+* activate publish on github pages by semantic release plugin ([8a9001c](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/8a9001cea81ea319a19af37f6545a0bc7a86a31d))
+* add Dockerfile ([2a36c9f](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/2a36c9f6b542ffb6d59fe8b3a915f15b83dae755))
+* add plugin for publish documentation to github pages ([99eb3c8](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/99eb3c8e3fd98388f268fc1443e6f8186e44606e))
+* change plugin for publish documentation to github pages ([ced9b0a](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/ced9b0ab4d85184eb7cca15726c1e156e82bff7d))
+* configure semantic release to deploy documentation on github pages ([683e53f](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/683e53f6383286a7ee51a2a4d9d5d6cac8221e2c))
+* ensure ci success before merging pull request ([4c124f4](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/4c124f4ab5dc3533f343fb84c3261bdd82ebf8e3))
+* update gitignore ([d1d1ba3](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/d1d1ba3a8d1ed41c8fdbc6e68a1fa48121bb8500))
+* update gitignore with checkstyle-idea file ([5065596](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/506559626d185616be0b497f828b3954a6a7639c))
+* update README ([f9800e0](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/f9800e04b39a1ae2826adbff26592f08fba534cd))
+
+
+### Build and continuous integration
+
+* add codecov action to generate coverage from jacoco report ([e0365aa](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/e0365aa1d2b767c1d773106f74f00489a461c544))
+* add docker image auto delivery ([05f996d](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/05f996d993fd29f7dfb9f8f268d8d1cca365fab2))
+* add docs generation step ([6073bda](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/6073bdaa781bf7679de69ffa711b7af8834b7f36))
+* **deps:** update docker/build-push-action action to v3.3.1 ([a19985a](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/a19985a3d47ce45d4c1133527c89314eeb3257fe))
+* **deps:** update docker/build-push-action action to v4 ([2f667d7](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/2f667d7835f9c55f6de1cc5f808de51d973b645d))
+* export version number from semantic release ([922a212](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/922a2125cb81b830026737608e7d0bd04cab57bc))
+* make image name lowercase ([3e34d6d](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/3e34d6d37b2ad7b682b0418ff2c2e6ed6f690327))
+* modify condition for documentation deploy ([76fcef6](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/76fcef6b274f8489ce642c2d49c77ae2cd572a16))
+* modify release concurrency group ([9002f26](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/9002f2625f0e6d1ad758b0ddb906c6c1af985a49))
+
+
+### Dependency updates
+
+* **core-deps:** update dependency org.jetbrains.kotlin:kotlin-stdlib to v1.8.10 ([d637f2e](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/d637f2ebc93c686311057c0790cb17a8db6af3e5))
+* **deps:** update node.js to 18.14 ([e7105c5](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/e7105c5c6d3192852b8d79056385e94bf6937264))
+* **deps:** update plugin com.gradle.enterprise to v3.12 ([ccce09d](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/ccce09d55f5b0a2ced1aefb6d0db386e47d1bc81))
+* **deps:** update plugin com.gradle.enterprise to v3.12.1 ([bf28ba4](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/bf28ba43df7a82e7cbcb8e44d2fa874f533da2de))
+* **deps:** update plugin com.gradle.enterprise to v3.12.2 ([5a11c72](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/5a11c72463d7d37f9f46070b429fa5973a5d4aa8))
+* **deps:** update plugin com.gradle.enterprise to v3.12.3 ([18e6393](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/18e63935ef61344e5079600d0f8adaa1a6283b28))
+* **deps:** update plugin kotlin-qa to v0.32.0 ([43155c8](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/43155c8a0fe2c07c3add9beeb42017822d2d0062))
+* **deps:** update plugin kotlin-qa to v0.33.0 ([7e80e6f](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/7e80e6f763899189951763d01d3cfc6daa554bce))
+* **deps:** update plugin org.danilopianini.gradle-pre-commit-git-hooks to v1.1.1 ([920e201](https://github.com/SmartOperatingBlock/kotlin-template-project/commit/920e201193df0f1cbe0a8c6f4104293ce0d99a3c))

.idea/copyright/SmartOperatingBlock.xml

@@ -0,0 +1,5 @@
+FROM alpine:3.17
+COPY ./ .
+RUN apk add openjdk17
+RUN ./gradlew compileKotlin
+ENTRYPOINT ./gradlew tasks

.idea/copyright/profiles_settings.xml

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Smart Operating Block
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.