Apply COPIERTemplate 0.6.0 with minimum optional questions (#50)

.JuliaFormatter.toml

@@ -2,12 +2,17 @@ align_assignment = true
 align_matrix = true
 align_pair_arrow = true
 align_struct_field = true
+always_for_in = true
+annotate_untyped_fields_with_any = false
 conditional_to_if = true
+for_in_replacement = "in"
 format_docstrings = false
 format_markdown = false
+import_to_using = true
 indent = 4
 margin = 100
 normalize_line_endings = "unix"
 remove_extra_newlines = true
 separate_kwargs_with_semicolon = true
-verbose = true
+whitespace_ops_in_indices = true
+whitespace_typedefs = true

.copier-answers.yml

@@ -0,0 +1,12 @@
+# Changes here will be overwritten by Copier
+AnswerStrategy: minimum
+AuthorEmail: [email protected]
+AuthorName: Suvayu Ali
+Indentation: 4
+JuliaMinVersion: '1.6'
+License: Apache-2.0
+PackageName: TulipaIO
+PackageOwner: TulipaEnergy
+PackageUUID: 7b3808b7-0819-42d4-885c-978ba173db11
+_commit: v0.6.0
+_src_path: https://github.com/abelsiqueira/COPIERTemplate.jl

.editorconfig

@@ -5,6 +5,6 @@ root = true
 end_of_line = lf
 insert_final_newline = true
 charset = utf-8
-indent_size = 2
+indent_size = 4
 indent_style = space
 trim_trailing_whitespace = true

.github/dependabot.yml

@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+    - package-ecosystem: "github-actions"
+      directory: "/" # Location of package manifests
+      schedule:
+          interval: "weekly"

.github/workflows/CompatHelper.yml

@@ -2,48 +2,50 @@
 name: CompatHelper
 
 on:
-  schedule:
-    - cron: 0 0 * * *
-  workflow_dispatch:
+    schedule:
+        - cron: 0 0 * * * # Every day at 00:00 UTC
+    workflow_dispatch:
 
 permissions:
-  contents: write
-  pull-requests: write
+    contents: write
+    pull-requests: write
 
 jobs:
-  CompatHelper:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check if Julia is already available in the PATH
-        id: julia_in_path
-        run: which julia
-        continue-on-error: true
-      - name: Install Julia, but only if it is not already available in the PATH
-        uses: julia-actions/setup-julia@v1
-        with:
-          version: "1"
-          arch: ${{ runner.arch }}
-        if: steps.julia_in_path.outcome != 'success'
-      - name: "Add the General registry via Git"
-        run: |
-          import Pkg
-          ENV["JULIA_PKG_SERVER"] = ""
-          Pkg.Registry.add("General")
-        shell: julia --color=yes {0}
-      - name: "Install CompatHelper"
-        run: |
-          import Pkg
-          name = "CompatHelper"
-          uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
-          version = "3"
-          Pkg.add(; name, uuid, version)
-        shell: julia --color=yes {0}
-      - name: "Run CompatHelper"
-        run: |
-          import CompatHelper
-          CompatHelper.main()
-        shell: julia --color=yes {0}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
-          # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}
+    CompatHelper:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check if Julia is already available in the PATH
+              id: julia_in_path
+              run: which julia
+              continue-on-error: true
+            - name: Install Julia, but only if it is not already available in the PATH
+              uses: julia-actions/setup-julia@v2
+              with:
+                  version: "1"
+                  arch: ${{ runner.arch }}
+              if: steps.julia_in_path.outcome != 'success'
+            - name: Use Julia cache
+              uses: julia-actions/cache@v2
+            - name: "Add the General registry via Git"
+              run: |
+                  import Pkg
+                  ENV["JULIA_PKG_SERVER"] = ""
+                  Pkg.Registry.add("General")
+              shell: julia --color=yes {0}
+            - name: "Install CompatHelper"
+              run: |
+                  import Pkg
+                  name = "CompatHelper"
+                  uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
+                  version = "3"
+                  Pkg.add(; name, uuid, version)
+              shell: julia --color=yes {0}
+            - name: "Run CompatHelper"
+              run: |
+                  import CompatHelper
+                  CompatHelper.main()
+              shell: julia --color=yes {0}
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+                  # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}

.github/workflows/Docs.yml

@@ -1,51 +1,53 @@
 name: Docs
 
 on:
-  push:
-    branches:
-      - main
-    paths:
-      - "docs/**"
-      - "src/**"
-      - "*.toml"
-    tags: ["*"]
-  pull_request:
-    branches:
-      - main
-    paths:
-      - "docs/**"
-      - "src/**"
-      - "*.toml"
-    types: [opened, synchronize, reopened]
+    push:
+        branches:
+            - main
+        paths:
+            - "docs/**"
+            - "src/**"
+            - "*.toml"
+        tags: ["*"]
+    pull_request:
+        branches:
+            - main
+        paths:
+            - "docs/**"
+            - "src/**"
+            - "*.toml"
+        types: [opened, synchronize, reopened]
 
 concurrency:
-  # Skip intermediate builds: always.
-  # Cancel intermediate builds: only if it is a pull request build.
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+    # Skip intermediate builds: always.
+    # Cancel intermediate builds: only if it is a pull request build.
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 
 jobs:
-  docs:
-    name: Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
-        with:
-          version: "1"
-      - run: |
-          julia --project=docs -e '
-            using Pkg
-            Pkg.develop(PackageSpec(path=pwd()))
-            Pkg.instantiate()'
-      - run: |
-          julia --project=docs -e '
-            using Documenter: DocMeta, doctest
-            using TulipaIO
-            DocMeta.setdocmeta!(TulipaIO, :DocTestSetup, :(using TulipaIO); recursive=true)
-            doctest(TulipaIO)'
-      - run: julia --project=docs docs/make.jl
-        env:
-          JULIA_PKG_SERVER: ""
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+    docs:
+        name: Documentation
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: julia-actions/setup-julia@v2
+              with:
+                  version: "1"
+            - name: Use Julia cache
+              uses: julia-actions/cache@v2
+            - run: |
+                  julia --project=docs -e '
+                    using Pkg
+                    Pkg.develop(PackageSpec(path=pwd()))
+                    Pkg.instantiate()'
+            - run: |
+                  julia --project=docs -e '
+                    using Documenter: DocMeta, doctest
+                    using TulipaIO
+                    DocMeta.setdocmeta!(TulipaIO, :DocTestSetup, :(using TulipaIO); recursive=true)
+                    doctest(TulipaIO)'
+            - run: julia --project=docs docs/make.jl
+              env:
+                  JULIA_PKG_SERVER: ""
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/Lint.yml

@@ -1,36 +1,36 @@
 name: Lint
 
 on:
-  push:
-    branches:
-      - main
-    tags: ["*"]
-  pull_request:
+    push:
+        branches:
+            - main
+        tags: ["*"]
+    pull_request:
 
 concurrency:
-  # Skip intermediate builds: always.
-  # Cancel intermediate builds: only if it is a pull request build.
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+    # Skip intermediate builds: always.
+    # Cancel intermediate builds: only if it is a pull request build.
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 
 jobs:
-  lint:
-    name: Linting
-    runs-on: ubuntu-latest
-    steps:
-      - name: Clone
-        uses: actions/checkout@v3
-      - name: Setup Julia
-        uses: julia-actions/setup-julia@v1
-        with:
-          version: "1"
-      - name: Use Julia cache
-        uses: julia-actions/cache@v1
-      - name: Install JuliaFormatter.jl
-        run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
-      - name: Setup Python
-        uses: actions/setup-python@v4
-      - name: Install pre-commit
-        run: pip install pre-commit
-      - name: Run pre-commit
-        run: SKIP=no-commit-to-branch pre-commit run -a
+    lint:
+        name: Linting
+        runs-on: ubuntu-latest
+        steps:
+            - name: Clone
+              uses: actions/checkout@v3
+            - name: Setup Julia
+              uses: julia-actions/setup-julia@v1
+              with:
+                  version: "1"
+            - name: Use Julia cache
+              uses: julia-actions/cache@v1
+            - name: Install JuliaFormatter.jl
+              run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
+            - name: Setup Python
+              uses: actions/setup-python@v4
+            - name: Install pre-commit
+              run: pip install pre-commit
+            - name: Run pre-commit
+              run: SKIP=no-commit-to-branch pre-commit run -a

.github/workflows/ReusableTest.yml

@@ -0,0 +1,52 @@
+name: Reusable test
+
+on:
+    workflow_call:
+        inputs:
+            version:
+                required: false
+                type: string
+                default: "1"
+            os:
+                required: false
+                type: string
+                default: ubuntu-latest
+            arch:
+                required: false
+                type: string
+                default: x64
+            allow_failure:
+                required: false
+                type: boolean
+                default: false
+            run_codecov:
+                required: false
+                type: boolean
+                default: false
+        secrets:
+            codecov_token:
+                required: true
+
+jobs:
+    test:
+        name: Julia ${{ inputs.version }} - ${{ inputs.os }} - ${{ inputs.arch }} - ${{ github.event_name }}
+        runs-on: ${{ inputs.os }}
+        continue-on-error: ${{ inputs.allow_failure }}
+
+        steps:
+            - uses: actions/checkout@v4
+            - uses: julia-actions/setup-julia@v2
+              with:
+                  version: ${{ inputs.version }}
+                  arch: ${{ inputs.arch }}
+            - name: Use Julia cache
+              uses: julia-actions/cache@v2
+            - uses: julia-actions/julia-buildpkg@v1
+            - uses: julia-actions/julia-runtest@v1
+            - uses: julia-actions/julia-processcoverage@v1
+              if: ${{ inputs.run_codecov }}
+            - uses: codecov/codecov-action@v4
+              if: ${{ inputs.run_codecov }}
+              with:
+                  file: lcov.info
+                  token: ${{ secrets.codecov_token }}