chore: 🤖 Apply BestieTemplate v0.7.2

.JuliaFormatter.toml

@@ -1,7 +1,18 @@
-margin = 100
+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 = 2
-whitespace_typedefs = true
-whitespace_ops_in_indices = true
+margin = 100
+normalize_line_endings = "unix"
 remove_extra_newlines = true
-annotate_untyped_fields_with_any = false
-normalize_line_endings = "unix"
+separate_kwargs_with_semicolon = true
+whitespace_ops_in_indices = true
+whitespace_typedefs = true

.all-contributorsrc

@@ -0,0 +1,5 @@
+{
+  "projectName": "JSOSuite",
+  "projectOwner": "JuliaSmoothOptimizers",
+  "files": ["README.md", "docs/src/index.md"]
+}

.cirrus.yml

@@ -1,31 +1,12 @@
+freebsd_instance:
+  image_family: freebsd-13-3
 task:
-  matrix:
-    - name: FreeBSD
-      freebsd_instance:
-        image_family: freebsd-13-3
-      env:
-        matrix:
-          - JULIA_VERSION: 1.6
-          - JULIA_VERSION: 1
-    - name: MacOS M1
-      macos_instance:
-        image: ghcr.io/cirruslabs/macos-ventura-base:latest
-      env:
-        - JULIA_VERSION: 1
-  install_script: |
-    URL="https://raw.githubusercontent.com/ararslan/CirrusCI.jl/master/bin/install.sh"
-    set -x
-    if [ "$(uname -s)" = "Linux" ] && command -v apt; then
-        apt update
-        apt install -y curl
-    fi
-    if command -v curl; then
-        sh -c "$(curl ${URL})"
-    elif command -v wget; then
-        sh -c "$(wget ${URL} -q -O-)"
-    elif command -v fetch; then
-        sh -c "$(fetch ${URL} -o -)"
-    fi
+  name: FreeBSD
+  env:
+    matrix:
+      - JULIA_VERSION: 1
+  install_script:
+    - sh -c "$(fetch https://raw.githubusercontent.com/ararslan/CirrusCI.jl/master/bin/install.sh -o -)"
   build_script:
     - cirrusjl build
   test_script:

.copier-answers.yml

@@ -0,0 +1,22 @@
+# Changes here will be overwritten by Copier
+AddAllcontributors: true
+AddCodeOfConduct: true
+AddCopierCI: false
+AddGitHubTemplates: true
+AddMacToCI: true
+AddPrecommit: true
+AddWinToCI: true
+AnswerStrategy: ask
+AuthorEmail: tangi.migot@gmail.com
+AuthorName: Tangi Migot
+Indentation: 2
+JuliaMinVersion: '1.6'
+License: MPL-2.0
+PackageName: JSOSuite
+PackageOwner: JuliaSmoothOptimizers
+PackageUUID: ed6ae0be-a024-11e9-2788-05dbf8cd15d9
+RunJuliaNightlyOnCI: false
+SimplifiedPRTest: true
+UseCirrusCI: true
+_commit: v0.7.2
+_src_path: https://github.com/abelsiqueira/BestieTemplate.jl

.editorconfig

@@ -0,0 +1,10 @@
+# https://editorconfig.org
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true

.github/ISSUE_TEMPLATE/10-bug-report.yml

@@ -0,0 +1,61 @@
+name: Bug Report
+description: File a bug report related to running the package
+title: "[Bug] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+        Please, before submitting, make sure that:
+
+        - There is not an [existing issue](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/issues) with the same question
+        - You have read the [contributing guide](https://JuliaSmoothOptimizers.github.io/JSOSuite.jl/dev/90-contributing/)
+        - You are following the [code of conduct](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/blob/main/CODE_OF_CONDUCT.md)
+
+        The form below should help you in filling out this issue.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe the bug
+    validations:
+      required: true
+  - type: input
+    id: pkg-version
+    attributes:
+      label: Package Version
+      description: What version of the package are you running?
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Julia Version
+      description: What version of Julia are you running?
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction steps
+      description: What steps led to the bug happening? Please provide a minimal reproducible example.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: dropdown
+    id: os
+    attributes:
+      label: "Operating System"
+      description: What is the impacted environment?
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - Mac

.github/ISSUE_TEMPLATE/20-feature-request.yml

@@ -0,0 +1,42 @@
+name: "Feature Request"
+description: Suggest a new feature for the package
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+
+        Please, before submitting, make sure that:
+
+        - There is not an [existing issue](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/issues) with the same question
+        - You have read the [contributing guide](https://JuliaSmoothOptimizers.github.io/JSOSuite.jl/dev/90-contributing/)
+        - You are following the [code of conduct](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/blob/main/CODE_OF_CONDUCT.md)
+
+        The form below should help you in filling out this issue.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe the requested feature
+    validations:
+      required: true
+  - type: textarea
+    id: validation
+    attributes:
+      label: Validation and testing
+      description: How could we verify that the new feature works? What kind of tests can be done?
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: Explain why this feature is relevant
+  - type: textarea
+    id: target
+    attributes:
+      label: Target audience
+      description: Tell more about the users of this feature, or where it could be useful
+  - type: textarea
+    id: can-help
+    attributes:
+      label: Can you help?
+      description: Can you help developing this feature?

.github/ISSUE_TEMPLATE/30-usage.yml

@@ -0,0 +1,24 @@
+name: "Usage question"
+description: Questions related to the usage
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this question!
+
+        Please, before submitting, make sure that:
+
+        - You have checked the [documentation](https://JuliaSmoothOptimizers.github.io/JSOSuite.jl) and haven't found enough information
+        - There is not an [existing issue](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/issues) with the same question
+        - You have read the [contributing guide](https://JuliaSmoothOptimizers.github.io/JSOSuite.jl/dev/90-contributing/)
+        - You are following the [code of conduct](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/blob/main/CODE_OF_CONDUCT.md)
+
+        The form below should help you in filling out this issue.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Write your question
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/99-general.yml

@@ -0,0 +1,22 @@
+name: "General issue"
+description: In case none of the others templates apply
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this issue!
+
+        Please, before submitting, make sure that:
+
+        - There is not an [existing issue](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/issues) with the same question
+        - You have read the [contributing guide](https://JuliaSmoothOptimizers.github.io/JSOSuite.jl/dev/90-contributing/)
+        - You are following the [code of conduct](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/blob/main/CODE_OF_CONDUCT.md)
+
+        The form below should help you in filling out this issue.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe the issue
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussions
+    url: https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/discussions
+    about: Create and follow discussions here

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+<!--
+Thanks for making a pull request to JSOSuite.jl.
+We have added this PR template to help you help us.
+Make sure to read the contributing guidelines and abide to the code of conduct.
+See the comments below, fill the required fields, and check the items.
+-->
+
+## Related issues
+
+<!-- We normally work with (i) create issue; (ii) discussion if necessary; (iii) create PR. So, at least one of the following should be true:-->
+
+<!-- Option 1, this closes an existing issue. Fill the number below-->
+Closes #
+
+<!-- Option 2, this is a small fix that arguably won't need an issue. Uncomment below -->
+<!--
+There is no related issue.
+-->
+
+## Checklist
+
+<!-- mark true if NA -->
+<!-- leave PR as draft until all is checked -->
+- [ ] I am following the [contributing guidelines](https://github.com/JuliaSmoothOptimizers/JSOSuite.jl/blob/main/docs/src/90-contributing.md)
+- [ ] Tests are passing
+- [ ] Lint workflow is passing
+- [ ] Docs were updated and workflow is passing

.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

@@ -3,7 +3,7 @@ name: CompatHelper
 
 on:
   schedule:
-    - cron: 0 0 * * *
+    - cron: 0 0 * * * # Every day at 00:00 UTC
   workflow_dispatch:
 
 permissions:
@@ -24,6 +24,8 @@ jobs:
           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

.github/workflows/Docs.yml

@@ -0,0 +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]
+
+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/') }}
+
+jobs:
+  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 JSOSuite
+            DocMeta.setdocmeta!(JSOSuite, :DocTestSetup, :(using JSOSuite); recursive=true)
+            doctest(JSOSuite)'
+      - run: julia --project=docs docs/make.jl
+        env:
+          JULIA_PKG_SERVER: ""
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}