From c4ae83e31a59e5efa17e23a0898c9b0bc7e4a225 Mon Sep 17 00:00:00 2001 From: ayushpatnaikgit Date: Tue, 19 Apr 2022 18:10:50 +0530 Subject: [PATCH] Files generated by PkgTemplates PkgTemplates version: 0.7.26 --- .github/workflows/CompatHelper.yml | 16 ++++++++++++++++ .github/workflows/TagBot.yml | 15 +++++++++++++++ .github/workflows/ci.yml | 26 ++++++++++++++++++++++++++ .github/workflows/documentation.yml | 25 +++++++++++++++++++++++++ .gitignore | 7 +++++++ LICENSE | 21 +++++++++++++++++++++ Project.toml | 7 +++++++ README.md | 10 ++++++++++ docs/Project.toml | 3 +++ docs/make.jl | 25 +++++++++++++++++++++++++ docs/src/index.md | 14 ++++++++++++++ src/Survey.jl | 5 +++++ test/Project.toml | 2 ++ test/runtests.jl | 6 ++++++ 14 files changed, 182 insertions(+) create mode 100644 .github/workflows/CompatHelper.yml create mode 100644 .github/workflows/TagBot.yml create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/documentation.yml create mode 100644 .gitignore create mode 100644 LICENSE 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/Survey.jl create mode 100644 test/Project.toml create mode 100644 test/runtests.jl diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml new file mode 100644 index 00000000..cba9134c --- /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 00000000..f49313b6 --- /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/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..d04d8035 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,26 @@ +name: CI + +on: + push: + branches: + - main + pull_request: + branches: + - main + # can add tags if needed + +jobs: + test: + name: Test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: julia-actions/setup-julia@latest + with: + version: '1.7' + - name: Install test dependencies + run: julia --project=test/ -e 'using Pkg; Pkg.instantiate()' + - name: Run tests + run: julia --project=. -e 'using Pkg; Pkg.test("{{PKG}}", coverage=true)' + - name: Codecov + run: julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder())' diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..6a12610d --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,25 @@ +name: Documentation + +on: + push: + branches: + - main + pull_request: + branches: + - main + # can add tags if needed +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: julia-actions/setup-julia@latest + with: + version: '1.7' + - name: Install documentation dependencies + run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' + - name: Build and deploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} + run: julia --project=docs/ docs/make.jl diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..47d3741a --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +*.jl.*.cov +*.jl.cov +*.jl.mem +/Manifest.toml +/docs/Manifest.toml +/docs/build/ +/test/Manifest.toml diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..ee58c5fd --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Ayush Patnaik + +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 00000000..e12549f8 --- /dev/null +++ b/Project.toml @@ -0,0 +1,7 @@ +name = "Survey" +uuid = "c1a98b4d-6cd2-47ec-b9e9-69b59c35373c" +authors = ["Ayush Patnaik"] +version = "0.1.0" + +[compat] +julia = "1" diff --git a/README.md b/README.md new file mode 100644 index 00000000..17ebe029 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# Survey + +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://xKDR.github.io/Survey.jl/dev) +![Build Status](https://github.com/xKDR/Survey.jl/actions/workflows/ci.yml/badge.svg) +![Build Status](https://github.com/xKDR/Survey.jl/actions/workflows/documentation.yml/badge.svg) +[![codecov](https://codecov.io/gh/xKDR/Survey}.jl/branch/main/graph/badge.svg?token=)](https://codecov.io/gh/xKDR/Survey}.jl) + +# To install: + + add "https://github.com/xKDR/Survey.jl.git" diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 00000000..1d2a187a --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +Survey = "c1a98b4d-6cd2-47ec-b9e9-69b59c35373c" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 00000000..b0f9dbae --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,25 @@ +using Survey +using Documenter + +DocMeta.setdocmeta!(Survey, :DocTestSetup, :(using Survey); recursive=true) + +makedocs(; + modules=[Survey], + authors="xKDR Forum", + repo="https://github.com/xKDR/Survey.jl/blob/{commit}{path}#{line}", + sitename="$Survey.jl", + format=Documenter.HTML(; + prettyurls=get(ENV, "CI", "false") == "true", + canonical="https://xKDR.github.io/Survey.jl", + assets=String[], + ), + pages=[ + "Home" => "index.md", + ], +) + +deploydocs(; + repo="github.com/xKDR/Survey.jl", + target = "build", + devbranch="main" +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 00000000..5af5c89c --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +```@meta +CurrentModule = Survey +``` + +# Survey + +Documentation for [Survey](https://github.com/Survey.jl). + +```@index +``` + +```@autodocs +Modules = [Survey] +``` diff --git a/src/Survey.jl b/src/Survey.jl new file mode 100644 index 00000000..fb47c179 --- /dev/null +++ b/src/Survey.jl @@ -0,0 +1,5 @@ +module Survey + +# Write your package code here. + +end diff --git a/test/Project.toml b/test/Project.toml new file mode 100644 index 00000000..0c363327 --- /dev/null +++ b/test/Project.toml @@ -0,0 +1,2 @@ +[deps] +Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" diff --git a/test/runtests.jl b/test/runtests.jl new file mode 100644 index 00000000..4de75742 --- /dev/null +++ b/test/runtests.jl @@ -0,0 +1,6 @@ +using Survey +using Test + +@testset "Survey.jl" begin + # Write your tests here. +end