Skip to content

Commit da14c81

Browse files
committed
Files generated by PkgTemplates
PkgTemplates version: 0.7.20
1 parent 7f05bb6 commit da14c81

File tree

13 files changed

+296
-0
lines changed

13 files changed

+296
-0
lines changed

Diff for: .github/workflows/CI.yml

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- main
6+
tags: '*'
7+
pull_request:
8+
jobs:
9+
test:
10+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
11+
runs-on: ${{ matrix.os }}
12+
strategy:
13+
fail-fast: false
14+
matrix:
15+
version:
16+
- '1.0'
17+
- '1.6'
18+
- 'nightly'
19+
os:
20+
- ubuntu-latest
21+
- macOS-latest
22+
- windows-latest
23+
arch:
24+
- x64
25+
- x86
26+
exclude:
27+
- os: macOS-latest
28+
arch: x86
29+
steps:
30+
- uses: actions/checkout@v2
31+
- uses: julia-actions/setup-julia@v1
32+
with:
33+
version: ${{ matrix.version }}
34+
arch: ${{ matrix.arch }}
35+
- uses: actions/cache@v1
36+
env:
37+
cache-name: cache-artifacts
38+
with:
39+
path: ~/.julia/artifacts
40+
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
41+
restore-keys: |
42+
${{ runner.os }}-test-${{ env.cache-name }}-
43+
${{ runner.os }}-test-
44+
${{ runner.os }}-
45+
- uses: julia-actions/julia-buildpkg@v1
46+
- uses: julia-actions/julia-runtest@v1
47+
- uses: julia-actions/julia-processcoverage@v1
48+
- uses: codecov/codecov-action@v1
49+
with:
50+
file: lcov.info
51+
docs:
52+
name: Documentation
53+
runs-on: ubuntu-latest
54+
steps:
55+
- uses: actions/checkout@v2
56+
- uses: julia-actions/setup-julia@v1
57+
with:
58+
version: '1'
59+
- uses: julia-actions/julia-buildpkg@v1
60+
- uses: julia-actions/julia-docdeploy@v1
61+
env:
62+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
63+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
64+
- run: |
65+
julia --project=docs -e '
66+
using Documenter: DocMeta, doctest
67+
using SimString
68+
DocMeta.setdocmeta!(SimString, :DocTestSetup, :(using SimString); recursive=true)
69+
doctest(SimString)'

Diff for: .github/workflows/CompatHelper.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: CompatHelper
2+
on:
3+
schedule:
4+
- cron: 0 0 * * *
5+
workflow_dispatch:
6+
jobs:
7+
CompatHelper:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Pkg.add("CompatHelper")
11+
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
12+
- name: CompatHelper.main()
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
16+
run: julia -e 'using CompatHelper; CompatHelper.main()'

Diff for: .github/workflows/TagBot.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: TagBot
2+
on:
3+
issue_comment:
4+
types:
5+
- created
6+
workflow_dispatch:
7+
jobs:
8+
TagBot:
9+
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: JuliaRegistries/TagBot@v1
13+
with:
14+
token: ${{ secrets.GITHUB_TOKEN }}
15+
ssh: ${{ secrets.DOCUMENTER_KEY }}

Diff for: .gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
*.jl.*.cov
2+
*.jl.cov
3+
*.jl.mem
4+
/Manifest.toml
5+
/docs/build/

Diff for: LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Bernard Brenyah
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: Project.toml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name = "SimString"
2+
uuid = "2e3c4037-312d-4650-b9c0-fcd0fc09aae4"
3+
authors = ["Bernard Brenyah"]
4+
version = "0.1.0"
5+
6+
[compat]
7+
julia = "1"
8+
9+
[extras]
10+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
11+
12+
[targets]
13+
test = ["Test"]

Diff for: README.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SimString
2+
3+
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://PyDataBlog.github.io/SimString.jl/stable)
4+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://PyDataBlog.github.io/SimString.jl/dev)
5+
[![Build Status](https://github.com/PyDataBlog/SimString.jl/workflows/CI/badge.svg)](https://github.com/PyDataBlog/SimString.jl/actions)
6+
[![Coverage](https://codecov.io/gh/PyDataBlog/SimString.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/PyDataBlog/SimString.jl)
7+
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
8+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)

Diff for: docs/Manifest.toml

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# This file is machine-generated - editing it directly is not advised
2+
3+
[[ANSIColoredPrinters]]
4+
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
5+
uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
6+
version = "0.0.1"
7+
8+
[[Base64]]
9+
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
10+
11+
[[Dates]]
12+
deps = ["Printf"]
13+
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
14+
15+
[[DocStringExtensions]]
16+
deps = ["LibGit2"]
17+
git-tree-sha1 = "a32185f5428d3986f47c2ab78b1f216d5e6cc96f"
18+
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
19+
version = "0.8.5"
20+
21+
[[Documenter]]
22+
deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
23+
git-tree-sha1 = "d8bd21fdac4152955040b47a72aa273880662f26"
24+
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
25+
version = "0.27.8"
26+
27+
[[IOCapture]]
28+
deps = ["Logging", "Random"]
29+
git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a"
30+
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
31+
version = "0.2.2"
32+
33+
[[InteractiveUtils]]
34+
deps = ["Markdown"]
35+
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
36+
37+
[[JSON]]
38+
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
39+
git-tree-sha1 = "8076680b162ada2a031f707ac7b4953e30667a37"
40+
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
41+
version = "0.21.2"
42+
43+
[[LibGit2]]
44+
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
45+
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
46+
47+
[[Logging]]
48+
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
49+
50+
[[Markdown]]
51+
deps = ["Base64"]
52+
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
53+
54+
[[Mmap]]
55+
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
56+
57+
[[NetworkOptions]]
58+
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
59+
60+
[[Parsers]]
61+
deps = ["Dates"]
62+
git-tree-sha1 = "98f59ff3639b3d9485a03a72f3ab35bab9465720"
63+
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
64+
version = "2.0.6"
65+
66+
[[Printf]]
67+
deps = ["Unicode"]
68+
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
69+
70+
[[REPL]]
71+
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
72+
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
73+
74+
[[Random]]
75+
deps = ["Serialization"]
76+
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
77+
78+
[[SHA]]
79+
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
80+
81+
[[Serialization]]
82+
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
83+
84+
[[SimString]]
85+
path = ".."
86+
uuid = "2e3c4037-312d-4650-b9c0-fcd0fc09aae4"
87+
version = "0.1.0"
88+
89+
[[Sockets]]
90+
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
91+
92+
[[Test]]
93+
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
94+
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
95+
96+
[[Unicode]]
97+
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

Diff for: docs/Project.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
SimString = "2e3c4037-312d-4650-b9c0-fcd0fc09aae4"

Diff for: docs/make.jl

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
using SimString
2+
using Documenter
3+
4+
DocMeta.setdocmeta!(SimString, :DocTestSetup, :(using SimString); recursive=true)
5+
6+
makedocs(;
7+
modules=[SimString],
8+
authors="Bernard Brenyah",
9+
repo="https://github.com/PyDataBlog/SimString.jl/blob/{commit}{path}#{line}",
10+
sitename="SimString.jl",
11+
format=Documenter.HTML(;
12+
prettyurls=get(ENV, "CI", "false") == "true",
13+
canonical="https://PyDataBlog.github.io/SimString.jl",
14+
assets=String[],
15+
),
16+
pages=[
17+
"Home" => "index.md",
18+
],
19+
)
20+
21+
deploydocs(;
22+
repo="github.com/PyDataBlog/SimString.jl",
23+
devbranch="main",
24+
)

Diff for: docs/src/index.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
```@meta
2+
CurrentModule = SimString
3+
```
4+
5+
# SimString
6+
7+
Documentation for [SimString](https://github.com/PyDataBlog/SimString.jl).
8+
9+
```@index
10+
```
11+
12+
```@autodocs
13+
Modules = [SimString]
14+
```

Diff for: src/SimString.jl

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module SimString
2+
3+
# Write your package code here.
4+
5+
end

Diff for: test/runtests.jl

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
using SimString
2+
using Test
3+
4+
@testset "SimString.jl" begin
5+
# Write your tests here.
6+
end

0 commit comments

Comments
 (0)