Skip to content

Commit 46ee01b

Browse files
SebastianM-CSebastianM-C
committed
Files generated by PkgTemplates
PkgTemplates version: 0.7.48
1 parent 020cef8 commit 46ee01b

File tree

14 files changed

+238
-0
lines changed

14 files changed

+238
-0
lines changed

‎.JuliaFormatter.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# See https://domluna.github.io/JuliaFormatter.jl/stable/ for a list of options

‎.github/dependabot.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
2+
version: 2
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/" # Location of package manifests
6+
schedule:
7+
interval: "weekly"

‎.github/workflows/CI.yml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- main
6+
tags: ['*']
7+
pull_request:
8+
workflow_dispatch:
9+
concurrency:
10+
# Skip intermediate builds: always.
11+
# Cancel intermediate builds: only if it is a pull request build.
12+
group: ${{ github.workflow }}-${{ github.ref }}
13+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
14+
jobs:
15+
test:
16+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
17+
runs-on: ${{ matrix.os }}
18+
timeout-minutes: 60
19+
permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
20+
actions: write
21+
contents: read
22+
strategy:
23+
fail-fast: false
24+
matrix:
25+
version:
26+
- '1.10'
27+
- 'nightly'
28+
os:
29+
- ubuntu-latest
30+
arch:
31+
- x64
32+
steps:
33+
- uses: actions/checkout@v4
34+
- uses: julia-actions/setup-julia@v1
35+
with:
36+
version: ${{ matrix.version }}
37+
arch: ${{ matrix.arch }}
38+
- uses: julia-actions/cache@v1
39+
- uses: julia-actions/julia-buildpkg@v1
40+
- uses: julia-actions/julia-runtest@v1
41+
- uses: julia-actions/julia-processcoverage@v1
42+
- uses: codecov/codecov-action@v3
43+
with:
44+
files: lcov.info
45+
docs:
46+
name: Documentation
47+
runs-on: ubuntu-latest
48+
permissions:
49+
actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created
50+
contents: write
51+
statuses: write
52+
steps:
53+
- uses: actions/checkout@v4
54+
- uses: julia-actions/setup-julia@v1
55+
with:
56+
version: '1'
57+
- uses: julia-actions/cache@v1
58+
- name: Configure doc environment
59+
shell: julia --project=docs --color=yes {0}
60+
run: |
61+
using Pkg
62+
Pkg.develop(PackageSpec(path=pwd()))
63+
Pkg.instantiate()
64+
- uses: julia-actions/julia-buildpkg@v1
65+
- uses: julia-actions/julia-docdeploy@v1
66+
env:
67+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
68+
- name: Run doctests
69+
shell: julia --project=docs --color=yes {0}
70+
run: |
71+
using Documenter: DocMeta, doctest
72+
using UDEComponents
73+
DocMeta.setdocmeta!(UDEComponents, :DocTestSetup, :(using UDEComponents); recursive=true)
74+
doctest(UDEComponents)

‎.github/workflows/CompatHelper.yml

Lines changed: 16 additions & 0 deletions
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()'

‎.github/workflows/TagBot.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: TagBot
2+
on:
3+
issue_comment:
4+
types:
5+
- created
6+
workflow_dispatch:
7+
inputs:
8+
lookback:
9+
default: 3
10+
permissions:
11+
actions: read
12+
checks: read
13+
contents: write
14+
deployments: read
15+
issues: read
16+
discussions: read
17+
packages: read
18+
pages: read
19+
pull-requests: read
20+
repository-projects: read
21+
security-events: read
22+
statuses: read
23+
jobs:
24+
TagBot:
25+
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: JuliaRegistries/TagBot@v1
29+
with:
30+
token: ${{ secrets.GITHUB_TOKEN }}
31+
ssh: ${{ secrets.DOCUMENTER_KEY }}

‎.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*.jl.*.cov
2+
*.jl.cov
3+
*.jl.mem
4+
/Manifest.toml
5+
/docs/Manifest.toml
6+
/docs/build/

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Sebastian Micluța-Câmpeanu <[email protected]> and contributors
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.

‎Project.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name = "UDEComponents"
2+
uuid = "f162e290-f571-43a6-83d9-22ecc16da15f"
3+
authors = ["Sebastian Micluța-Câmpeanu <[email protected]> and contributors"]
4+
version = "1.0.0-DEV"
5+
6+
[compat]
7+
julia = "1.10"
8+
9+
[extras]
10+
Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
11+
JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
12+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
13+
14+
[targets]
15+
test = ["Aqua", "JET", "Test"]

‎README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# UDEComponents
2+
3+
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://SebastianM-C.github.io/UDEComponents.jl/stable/)
4+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://SebastianM-C.github.io/UDEComponents.jl/dev/)
5+
[![Build Status](https://github.com/SebastianM-C/UDEComponents.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/SebastianM-C/UDEComponents.jl/actions/workflows/CI.yml?query=branch%3Amain)
6+
[![Coverage](https://codecov.io/gh/SebastianM-C/UDEComponents.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/SebastianM-C/UDEComponents.jl)
7+
[![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)
8+
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

‎docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
UDEComponents = "f162e290-f571-43a6-83d9-22ecc16da15f"

‎docs/make.jl

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
using UDEComponents
2+
using Documenter
3+
4+
DocMeta.setdocmeta!(UDEComponents, :DocTestSetup, :(using UDEComponents); recursive=true)
5+
6+
makedocs(;
7+
modules=[UDEComponents],
8+
authors="Sebastian Micluța-Câmpeanu <[email protected]> and contributors",
9+
sitename="UDEComponents.jl",
10+
format=Documenter.HTML(;
11+
canonical="https://SebastianM-C.github.io/UDEComponents.jl",
12+
edit_link="main",
13+
assets=String[],
14+
),
15+
pages=[
16+
"Home" => "index.md",
17+
],
18+
)
19+
20+
deploydocs(;
21+
repo="github.com/SebastianM-C/UDEComponents.jl",
22+
devbranch="main",
23+
)

‎docs/src/index.md

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

‎src/UDEComponents.jl

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module UDEComponents
2+
3+
# Write your package code here.
4+
5+
end

‎test/runtests.jl

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
using UDEComponents
2+
using Test
3+
using Aqua
4+
using JET
5+
6+
@testset "UDEComponents.jl" begin
7+
@testset "Code quality (Aqua.jl)" begin
8+
Aqua.test_all(UDEComponents)
9+
end
10+
@testset "Code linting (JET.jl)" begin
11+
JET.test_package(UDEComponents; target_defined_modules = true)
12+
end
13+
# Write your tests here.
14+
end

0 commit comments

Comments
 (0)