diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml new file mode 100644 index 0000000..ad8d929 --- /dev/null +++ b/.github/workflows/CI.yml @@ -0,0 +1,40 @@ +name: CI +on: + 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/') }} +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.9' + - 'nightly' + os: + - ubuntu-latest + arch: + - x64 + steps: + - uses: actions/checkout@v3 + - 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@v3 + with: + files: lcov.info 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..2bacdb8 --- /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..0887050 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +*.jl.*.cov +*.jl.cov +*.jl.mem +/docs/Manifest.toml +/docs/build/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..1ec9f7a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,47 @@ +# Documentation: http://docs.travis-ci.com/user/languages/julia +language: julia +notifications: + email: false +julia: + - 1.0 + - 1.9 + - nightly +os: + - linux +arch: + - x64 + - x86 +cache: + directories: + - ~/.julia/artifacts +jobs: + fast_finish: true + allow_failures: + - julia: nightly + include: + - stage: Documentation + julia: 1 + script: + - | + julia --project=docs -e ' + using Pkg + Pkg.develop(PackageSpec(path=pwd())) + Pkg.instantiate()' + - | + julia --project=docs -e ' + using Pkg + Pkg.develop(PackageSpec(path=pwd())) + Pkg.instantiate() + using Documenter: DocMeta, doctest + using Kang + DocMeta.setdocmeta!(Kang, :DocTestSetup, :(using Kang); recursive=true) + doctest(Kang) + include("docs/make.jl")' + after_success: skip +after_success: + - | + julia -e ' + using Pkg + Pkg.add("Coverage") + using Coverage + Codecov.submit(process_folder())' diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..789b345 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Dominic and contributors + +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..7634cae --- /dev/null +++ b/Project.toml @@ -0,0 +1,13 @@ +name = "Kang" +uuid = "54806c32-d51a-438d-8447-e0041be2fbfb" +authors = ["Dominic and contributors"] +version = "1.0.0-DEV" + +[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..75644d9 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# Kang + +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://dchang10.github.io/Kang.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://dchang10.github.io/Kang.jl/dev/) +[![Build Status](https://github.com/dchang10/Kang.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/dchang10/Kang.jl/actions/workflows/CI.yml?query=branch%3Amain) +[![Build Status](https://travis-ci.com/dchang10/Kang.jl.svg?branch=main)](https://travis-ci.com/dchang10/Kang.jl) +[![Coverage](https://codecov.io/gh/dchang10/Kang.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/dchang10/Kang.jl) diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..f2d63c1 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +Kang = "54806c32-d51a-438d-8447-e0041be2fbfb" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..2f81c1d --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,25 @@ +using Kang +using Documenter + +DocMeta.setdocmeta!(Kang, :DocTestSetup, :(using Kang); recursive=true) + +makedocs(; + modules=[Kang], + authors="Dominic and contributors", + repo="https://github.com/dchang10/Kang.jl/blob/{commit}{path}#{line}", + sitename="Kang.jl", + format=Documenter.HTML(; + prettyurls=get(ENV, "CI", "false") == "true", + canonical="https://dchang10.github.io/Kang.jl", + edit_link="main", + assets=String[], + ), + pages=[ + "Home" => "index.md", + ], +) + +deploydocs(; + repo="github.com/dchang10/Kang.jl", + devbranch="main", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..56a441d --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +```@meta +CurrentModule = Kang +``` + +# Kang + +Documentation for [Kang](https://github.com/dchang10/Kang.jl). + +```@index +``` + +```@autodocs +Modules = [Kang] +``` diff --git a/src/Kang.jl b/src/Kang.jl new file mode 100644 index 0000000..9bcc401 --- /dev/null +++ b/src/Kang.jl @@ -0,0 +1,5 @@ +module Kang + +# Write your package code here. + +end diff --git a/test/runtests.jl b/test/runtests.jl new file mode 100644 index 0000000..f978242 --- /dev/null +++ b/test/runtests.jl @@ -0,0 +1,6 @@ +using Kang +using Test + +@testset "Kang.jl" begin + # Write your tests here. +end