From b7c82613d4af247e1c1e5fa0970fb442deedebc2 Mon Sep 17 00:00:00 2001 From: Oriol Colomes Date: Mon, 29 Apr 2024 08:11:16 +0200 Subject: [PATCH] Files generated by PkgTemplates PkgTemplates version: 0.7.49 --- .github/dependabot.yml | 7 +++ .github/workflows/CI.yml | 79 ++++++++++++++++++++++++++++++ .github/workflows/CompatHelper.yml | 16 ++++++ .github/workflows/TagBot.yml | 31 ++++++++++++ .gitignore | 10 ++++ LICENSE.md | 21 ++++++++ Project.toml | 13 +++++ README.md | 6 +++ docs/Project.toml | 3 ++ docs/make.jl | 23 +++++++++ docs/src/index.md | 14 ++++++ src/ClosestPointSTL.jl | 5 ++ test/runtests.jl | 6 +++ 13 files changed, 234 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/CI.yml create mode 100644 .github/workflows/CompatHelper.yml create mode 100644 .github/workflows/TagBot.yml create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 Project.toml create mode 100644 README.md create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/index.md create mode 100644 src/ClosestPointSTL.jl create mode 100644 test/runtests.jl diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..700707c --- /dev/null +++ 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/CI.yml b/.github/workflows/CI.yml new file mode 100644 index 0000000..2f6afd5 --- /dev/null +++ b/.github/workflows/CI.yml @@ -0,0 +1,79 @@ +name: CI +on: + push: + branches: + - main + tags: ['*'] + pull_request: + workflow_dispatch: +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: + test: + name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }} + runs-on: ${{ matrix.os }} + timeout-minutes: 60 + permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created + actions: write + contents: read + strategy: + fail-fast: false + matrix: + version: + - '1.7' + - '1.8' + - 'nightly' + os: + - ubuntu-latest + - windows-latest + arch: + - x64 + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@v1 + with: + version: ${{ matrix.version }} + arch: ${{ matrix.arch }} + - uses: julia-actions/cache@v1 + - uses: julia-actions/julia-buildpkg@v1 + - uses: julia-actions/julia-runtest@v1 + - uses: julia-actions/julia-processcoverage@v1 + - uses: codecov/codecov-action@v4 + with: + files: lcov.info + token: ${{ secrets.CODECOV_TOKEN }} + fail_ci_if_error: false + docs: + name: Documentation + runs-on: ubuntu-latest + permissions: + actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created + contents: write + statuses: write + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@v1 + with: + version: '1' + - uses: julia-actions/cache@v1 + - name: Configure doc environment + shell: julia --project=docs --color=yes {0} + run: | + using Pkg + Pkg.develop(PackageSpec(path=pwd())) + Pkg.instantiate() + - uses: julia-actions/julia-buildpkg@v1 + - uses: julia-actions/julia-docdeploy@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} + - name: Run doctests + shell: julia --project=docs --color=yes {0} + run: | + using Documenter: DocMeta, doctest + using ClosestPointSTL + DocMeta.setdocmeta!(ClosestPointSTL, :DocTestSetup, :(using ClosestPointSTL); recursive=true) + doctest(ClosestPointSTL) diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml new file mode 100644 index 0000000..cba9134 --- /dev/null +++ b/.github/workflows/CompatHelper.yml @@ -0,0 +1,16 @@ +name: CompatHelper +on: + schedule: + - cron: 0 0 * * * + workflow_dispatch: +jobs: + CompatHelper: + runs-on: ubuntu-latest + steps: + - name: Pkg.add("CompatHelper") + run: julia -e 'using Pkg; Pkg.add("CompatHelper")' + - name: CompatHelper.main() + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} + run: julia -e 'using CompatHelper; CompatHelper.main()' diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml new file mode 100644 index 0000000..0cd3114 --- /dev/null +++ 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/.gitignore b/.gitignore new file mode 100644 index 0000000..e095ba2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +*.code-workspace +*.jl.*.cov +*.jl.cov +*.jl.mem +.DS_Store +/docs/Manifest.toml +/docs/build/ +Manifest.toml +docs/build/ +tmp/ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..cd41453 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Oriol Colomese + +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 new file mode 100644 index 0000000..776cb2d --- /dev/null +++ b/Project.toml @@ -0,0 +1,13 @@ +name = "ClosestPointSTL" +uuid = "d67795cd-1ce3-49ca-af90-d17877315498" +authors = ["Oriol Colomese "] +version = "1.0.0-DEV" + +[compat] +julia = "1.7" + +[extras] +Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[targets] +test = ["Test"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..e5f0db0 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# ClosestPointSTL + +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://oriolcg.github.io/ClosestPointSTL.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://oriolcg.github.io/ClosestPointSTL.jl/dev/) +[![Build Status](https://github.com/oriolcg/ClosestPointSTL.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/oriolcg/ClosestPointSTL.jl/actions/workflows/CI.yml?query=branch%3Amain) +[![Coverage](https://codecov.io/gh/oriolcg/ClosestPointSTL.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/oriolcg/ClosestPointSTL.jl) diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..8a1f980 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +ClosestPointSTL = "d67795cd-1ce3-49ca-af90-d17877315498" +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..cea3486 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,23 @@ +using ClosestPointSTL +using Documenter + +DocMeta.setdocmeta!(ClosestPointSTL, :DocTestSetup, :(using ClosestPointSTL); recursive=true) + +makedocs(; + modules=[ClosestPointSTL], + authors="Oriol Colomese ", + sitename="ClosestPointSTL.jl", + format=Documenter.HTML(; + canonical="https://oriolcg.github.io/ClosestPointSTL.jl", + edit_link="main", + assets=String[], + ), + pages=[ + "Home" => "index.md", + ], +) + +deploydocs(; + repo="github.com/oriolcg/ClosestPointSTL.jl", + devbranch="main", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..024982a --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +```@meta +CurrentModule = ClosestPointSTL +``` + +# ClosestPointSTL + +Documentation for [ClosestPointSTL](https://github.com/oriolcg/ClosestPointSTL.jl). + +```@index +``` + +```@autodocs +Modules = [ClosestPointSTL] +``` diff --git a/src/ClosestPointSTL.jl b/src/ClosestPointSTL.jl new file mode 100644 index 0000000..253a132 --- /dev/null +++ b/src/ClosestPointSTL.jl @@ -0,0 +1,5 @@ +module ClosestPointSTL + +# Write your package code here. + +end diff --git a/test/runtests.jl b/test/runtests.jl new file mode 100644 index 0000000..5151b20 --- /dev/null +++ b/test/runtests.jl @@ -0,0 +1,6 @@ +using ClosestPointSTL +using Test + +@testset "ClosestPointSTL.jl" begin + # Write your tests here. +end