Initial commit

ocots · web-flow · commit d59d7e2e5232 · 2025-10-24T09:52:21.000+02:00
diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md
@@ -0,0 +1,10 @@
+---
+name: Blank issue
+about: Blank template for general issue
+title: "[General] "
+labels: ''
+assignees: ocots
+
+---
+
+
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a bug report to help us improve
+title: "[Bug] "
+labels: bug
+assignees: ocots
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Give if possible the code to reproduce the error:
+
+```julia
+julia> f(x)=1
+f (generic function with 1 method)
+
+julia> f()
+ERROR: MethodError: no method matching f()
+```
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: CTAppTemplate.jl package support
+    url: https://github.com/control-toolbox/CTAppTemplate.jl/discussions
+    about: Please ask and answer questions about CTAppTemplate.jl here.
+  - name: Control-toolbox organisation support
+    url: https://github.com/orgs/control-toolbox/discussions
+    about: For more general questions about control-toolbox ecosystem it's here.
diff --git a/.github/ISSUE_TEMPLATE/developers.md b/.github/ISSUE_TEMPLATE/developers.md
@@ -0,0 +1,10 @@
+---
+name: 'Developers '
+about: Suggest internal modifications
+title: "[Dev] "
+labels: internal dev
+assignees: ocots 
+
+---
+
+
diff --git a/.github/ISSUE_TEMPLATE/documentation-suggestion.md b/.github/ISSUE_TEMPLATE/documentation-suggestion.md
@@ -0,0 +1,10 @@
+---
+name: Documentation suggestion
+about: Suggest improvements or additions to the documentation
+title: "[Doc] "
+labels: documentation
+assignees: ocots 
+
+---
+
+**Please detail your suggestion.**
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Feature] "
+labels: enhancement
+assignees: ocots 
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/codecov.yml b/.github/codecov.yml
@@ -0,0 +1,8 @@
+coverage:
+  status:
+    project:
+      default:
+        informational: true
+    patch:
+      default:
+        informational: true
diff --git a/.github/dependabot.yml b/.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"
diff --git a/.github/workflows/AutoAssign.yml b/.github/workflows/AutoAssign.yml
@@ -0,0 +1,12 @@
+name: Auto Assign
+on:
+  issues:
+    types: [opened, reopened]
+  pull_request:
+    types: [opened, reopened]
+jobs:
+  call:
+    uses: control-toolbox/CTActions/.github/workflows/auto-assign.yml@main
+    with:
+      assignees: ocots
+      numOfAssignee: 1
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -0,0 +1,12 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+    
+jobs:
+  call:
+    uses: control-toolbox/CTActions/.github/workflows/ci.yml@main
diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml
@@ -0,0 +1,8 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  call:
+    uses: control-toolbox/CTActions/.github/workflows/compat-helper.yml@main
diff --git a/.github/workflows/Coverage.yml b/.github/workflows/Coverage.yml
@@ -0,0 +1,11 @@
+name: coverage
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+jobs:
+  call:
+    uses: control-toolbox/CTActions/.github/workflows/coverage.yml@main
+    secrets:
+      codecov-secret: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -0,0 +1,12 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+  
+jobs:
+  call:
+    uses: control-toolbox/CTActions/.github/workflows/documentation.yml@main
diff --git a/.github/workflows/Formatter.yml b/.github/workflows/Formatter.yml
@@ -0,0 +1,10 @@
+name: Formatter
+
+on:
+    schedule:
+      - cron: '0 0 * * *'
+    workflow_dispatch:
+
+jobs:
+  call:
+    uses: control-toolbox/CTActions/.github/workflows/formatter.yml@main
diff --git a/.github/workflows/SpellCheck.yml b/.github/workflows/SpellCheck.yml
@@ -0,0 +1,9 @@
+name: Spell Check
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  call:
+    uses: control-toolbox/CTActions/.github/workflows/spell-check.yml@main
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
@@ -0,0 +1,31 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+    inputs:
+      lookback:
+        default: "3"
+permissions:
+  actions: read
+  checks: read
+  contents: write
+  deployments: read
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  pull-requests: read
+  repository-projects: read
+  security-events: read
+  statuses: read
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/.github/workflows/UpdateReadme.yml b/.github/workflows/UpdateReadme.yml
@@ -0,0 +1,40 @@
+name: Update README with ABOUT.md and INSTALL.md
+
+on:
+  schedule:
+    - cron: '0 6 * * 1'   # every Monday at 06:00 UTC
+  workflow_dispatch:       # manual trigger
+
+jobs:
+  check-template:
+    runs-on: ubuntu-latest
+    outputs:
+      has_template: ${{ steps.check.outputs.has_template }}
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Check for README.template.md
+        id: check
+        shell: bash
+        run: |
+          if [[ -f "README.template.md" ]]; then
+            echo "has_template=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "has_template=false" >> "$GITHUB_OUTPUT"
+            echo "README.template.md not found. Skipping README update." >&2
+          fi
+
+  call-shared:
+    needs: check-template
+    if: ${{ needs.check-template.outputs.has_template == 'true' }}
+    uses: control-toolbox/CTActions/.github/workflows/update-readme.yml@main
+    with:
+      template_file: README.template.md
+      output_file: README.md
+      package_name: CTAppTemplate                            # package for INSTALL.md
+      repo_name: control-toolbox/CTAppTemplate.jl            # repository for CONTRIBUTING.md links
+      doc_url: https://control-toolbox.org/CTAppTemplate.jl
+      citation_badge: "[![DOI](https://zenodo.org/badge/541187171.svg)](https://zenodo.org/doi/10.5281/zenodo.16753152)" # example, can be empty
+      assignee: "ocots"
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,32 @@
+.DS_Store
+.vscode
+
+# Files generated by invoking Julia with --code-coverage
+*.jl.cov
+*.jl.*.cov
+
+# Files generated by invoking Julia with --track-allocation
+*.jl.mem
+
+# System-specific files and directories generated by the BinaryProvider and BinDeps packages
+# They contain absolute paths specific to the host computer, and so should not be committed
+deps/deps.jl
+deps/build.log
+deps/downloads/
+deps/usr/
+deps/src/
+
+# Build artifacts for creating documentation generated by the Documenter package
+docs/build/
+docs/site/
+
+# --------------------
+# Julia Environment Files
+# --------------------
+# Keep Project.toml; ignore Manifest.toml in packages
+!Project.toml
+# Ignore all Manifest.toml files...
+Manifest.toml
+**/Manifest.toml
+# ...except the one inside docs/src/assets
+!docs/src/assets/Manifest.toml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+## Contributing
+
+[issue-url]: https://github.com/control-toolbox/CTAppTemplate.jl/issues
+[first-good-issue-url]: https://github.com/control-toolbox/CTAppTemplate.jl/contribute
+
+If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url].  
+Before opening a pull request, please start an issue or a discussion on the topic. 
+
+Contributions are welcomed, check out [how to contribute to a Github project](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project). If it is your first contribution, you can also check [this first contribution tutorial](https://github.com/firstcontributions/first-contributions). You can find first good issues (if any 🙂) [here][first-good-issue-url]. You may find other packages to contribute to at the [control-toolbox organization](https://github.com/control-toolbox).
+
+If you want to ask a question, feel free to start a discussion [here](https://github.com/orgs/control-toolbox/discussions). This forum is for general discussion about this repository and the [control-toolbox organization](https://github.com/control-toolbox).
+
+>[!NOTE]
+> If you want to add an application or a package to the control-toolbox ecosystem, please follow this [set up tutorial](https://github.com/orgs/control-toolbox/discussions/65).
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Olivier Cots <olivier.cots@toulouse-inp.fr>
+
+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.
diff --git a/Project.toml b/Project.toml
@@ -0,0 +1,7 @@
+name = "CTAppTemplate"
+uuid = "eb604665-d64b-4d02-aa6d-8b42324a08dc"
+authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]
+version = "0.2.0"
+
+[compat]
+julia = "1.11"
diff --git a/README.md b/README.md
diff --git a/README.template.md b/README.template.md
diff --git a/docs/Project.toml b/docs/Project.toml
diff --git a/docs/make.jl b/docs/make.jl
diff --git a/docs/src/index.md b/docs/src/index.md
diff --git a/src/CTAppTemplate.jl b/src/CTAppTemplate.jl
diff --git a/test/Project.toml b/test/Project.toml
diff --git a/test/runtests.jl b/test/runtests.jl
diff --git a/test/test_aqua.jl b/test/test_aqua.jl
diff --git a/test/test_default.jl b/test/test_default.jl
