From a0a6f11162f66cf2e225c9c7e356786b5f0d18fe Mon Sep 17 00:00:00 2001 From: Marek Kaluba Date: Sun, 20 Jun 2021 12:54:36 +0200 Subject: [PATCH] Files generated by PkgTemplates PkgTemplates version: 0.7.16 --- .github/workflows/CI.yml | 64 +++++++++++++++++++++ .github/workflows/CompatHelper.yml | 16 ++++++ .github/workflows/TagBot.yml | 15 +++++ .gitignore | 4 ++ LICENSE | 21 +++++++ Manifest.toml | 2 + Project.toml | 13 +++++ README.md | 6 ++ docs/Manifest.toml | 92 ++++++++++++++++++++++++++++++ docs/Project.toml | 3 + docs/make.jl | 23 ++++++++ docs/src/index.md | 14 +++++ src/StarAlgebras.jl | 5 ++ test/runtests.jl | 6 ++ 14 files changed, 284 insertions(+) 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 create mode 100644 Manifest.toml create mode 100644 Project.toml create mode 100644 README.md create mode 100644 docs/Manifest.toml create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/index.md create mode 100644 src/StarAlgebras.jl create mode 100644 test/runtests.jl diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml new file mode 100644 index 0000000..9dabf33 --- /dev/null +++ b/.github/workflows/CI.yml @@ -0,0 +1,64 @@ +name: CI +on: + - push + - pull_request +jobs: + test: + name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }} + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + version: + - '1.0' + - '1.6' + - 'nightly' + os: + - ubuntu-latest + arch: + - x64 + steps: + - uses: actions/checkout@v2 + - uses: julia-actions/setup-julia@v1 + with: + version: ${{ matrix.version }} + arch: ${{ matrix.arch }} + - uses: actions/cache@v1 + env: + cache-name: cache-artifacts + with: + path: ~/.julia/artifacts + key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }} + restore-keys: | + ${{ runner.os }}-test-${{ env.cache-name }}- + ${{ runner.os }}-test- + ${{ runner.os }}- + - uses: julia-actions/julia-buildpkg@v1 + - uses: julia-actions/julia-runtest@v1 + - uses: julia-actions/julia-processcoverage@v1 + - uses: codecov/codecov-action@v1 + with: + file: lcov.info + 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 StarAlgebras + DocMeta.setdocmeta!(StarAlgebras, :DocTestSetup, :(using StarAlgebras); recursive=true) + doctest(StarAlgebras)' + - run: julia --project=docs docs/make.jl + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} 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..f49313b --- /dev/null +++ b/.github/workflows/TagBot.yml @@ -0,0 +1,15 @@ +name: TagBot +on: + issue_comment: + types: + - created + workflow_dispatch: +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..3af67b1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +*.jl.*.cov +*.jl.cov +*.jl.mem +/docs/build/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..07b628f --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Marek Kaluba + +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/Manifest.toml b/Manifest.toml new file mode 100644 index 0000000..f45eecf --- /dev/null +++ b/Manifest.toml @@ -0,0 +1,2 @@ +# This file is machine-generated - editing it directly is not advised + diff --git a/Project.toml b/Project.toml new file mode 100644 index 0000000..ad372ab --- /dev/null +++ b/Project.toml @@ -0,0 +1,13 @@ +name = "StarAlgebras" +uuid = "0c0c59c1-dc5f-42e9-9a8b-b5dc384a6cd1" +authors = ["Marek Kaluba "] +version = "0.1.0" + +[compat] +julia = "1" + +[extras] +Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[targets] +test = ["Test"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..63e06a7 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# StarAlgebras + +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://kalmar@amu.edu.pl.github.io/StarAlgebras.jl/stable) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://kalmar@amu.edu.pl.github.io/StarAlgebras.jl/dev) +[![Build Status](https://github.com/kalmar@amu.edu.pl/StarAlgebras.jl/workflows/CI/badge.svg)](https://github.com/kalmar@amu.edu.pl/StarAlgebras.jl/actions) +[![Coverage](https://codecov.io/gh/kalmar@amu.edu.pl/StarAlgebras.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/kalmar@amu.edu.pl/StarAlgebras.jl) diff --git a/docs/Manifest.toml b/docs/Manifest.toml new file mode 100644 index 0000000..284d8d7 --- /dev/null +++ b/docs/Manifest.toml @@ -0,0 +1,92 @@ +# This file is machine-generated - editing it directly is not advised + +[[Base64]] +uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" + +[[Dates]] +deps = ["Printf"] +uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" + +[[DocStringExtensions]] +deps = ["LibGit2"] +git-tree-sha1 = "a32185f5428d3986f47c2ab78b1f216d5e6cc96f" +uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" +version = "0.8.5" + +[[Documenter]] +deps = ["Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] +git-tree-sha1 = "621850838b3e74dd6dd047b5432d2e976877104e" +uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +version = "0.27.2" + +[[IOCapture]] +deps = ["Logging", "Random"] +git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a" +uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89" +version = "0.2.2" + +[[InteractiveUtils]] +deps = ["Markdown"] +uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" + +[[JSON]] +deps = ["Dates", "Mmap", "Parsers", "Unicode"] +git-tree-sha1 = "81690084b6198a2e1da36fcfda16eeca9f9f24e4" +uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" +version = "0.21.1" + +[[LibGit2]] +deps = ["Base64", "NetworkOptions", "Printf", "SHA"] +uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" + +[[Logging]] +uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" + +[[Markdown]] +deps = ["Base64"] +uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" + +[[Mmap]] +uuid = "a63ad114-7e13-5084-954f-fe012c677804" + +[[NetworkOptions]] +uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908" + +[[Parsers]] +deps = ["Dates"] +git-tree-sha1 = "c8abc88faa3f7a3950832ac5d6e690881590d6dc" +uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" +version = "1.1.0" + +[[Printf]] +deps = ["Unicode"] +uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7" + +[[REPL]] +deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"] +uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb" + +[[Random]] +deps = ["Serialization"] +uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" + +[[SHA]] +uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" + +[[Serialization]] +uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" + +[[Sockets]] +uuid = "6462fe0b-24de-5631-8697-dd941f90decc" + +[[StarAlgebras]] +path = ".." +uuid = "0c0c59c1-dc5f-42e9-9a8b-b5dc384a6cd1" +version = "0.1.0" + +[[Test]] +deps = ["InteractiveUtils", "Logging", "Random", "Serialization"] +uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[[Unicode]] +uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..0a1cb34 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +StarAlgebras = "0c0c59c1-dc5f-42e9-9a8b-b5dc384a6cd1" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..06a5806 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,23 @@ +using StarAlgebras +using Documenter + +DocMeta.setdocmeta!(StarAlgebras, :DocTestSetup, :(using StarAlgebras); recursive=true) + +makedocs(; + modules=[StarAlgebras], + authors="Marek Kaluba ", + repo="https://github.com/kalmar@amu.edu.pl/StarAlgebras.jl/blob/{commit}{path}#{line}", + sitename="StarAlgebras.jl", + format=Documenter.HTML(; + prettyurls=get(ENV, "CI", "false") == "true", + canonical="https://kalmar@amu.edu.pl.github.io/StarAlgebras.jl", + assets=String[], + ), + pages=[ + "Home" => "index.md", + ], +) + +deploydocs(; + repo="github.com/kalmar@amu.edu.pl/StarAlgebras.jl", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..e16cfd1 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +```@meta +CurrentModule = StarAlgebras +``` + +# StarAlgebras + +Documentation for [StarAlgebras](https://github.com/kalmar@amu.edu.pl/StarAlgebras.jl). + +```@index +``` + +```@autodocs +Modules = [StarAlgebras] +``` diff --git a/src/StarAlgebras.jl b/src/StarAlgebras.jl new file mode 100644 index 0000000..9edc094 --- /dev/null +++ b/src/StarAlgebras.jl @@ -0,0 +1,5 @@ +module StarAlgebras + +# Write your package code here. + +end diff --git a/test/runtests.jl b/test/runtests.jl new file mode 100644 index 0000000..5b45354 --- /dev/null +++ b/test/runtests.jl @@ -0,0 +1,6 @@ +using StarAlgebras +using Test + +@testset "StarAlgebras.jl" begin + # Write your tests here. +end