Skip to content

Commit 13a9830

Browse files
oschulzoschulz
committed
Initial package layout
1 parent 81c61a3 commit 13a9830

18 files changed

+317
-0
lines changed

‎.codecov.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# comment: false

‎.github/workflows/CompatHelper.yml

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

‎.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 }}

‎.github/workflows/ci.yml

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- dev
8+
- 'releases/**'
9+
tags: '*'
10+
pull_request:
11+
release:
12+
13+
jobs:
14+
test:
15+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
16+
runs-on: ${{ matrix.os }}
17+
continue-on-error: ${{ matrix.version == 'nightly' }}
18+
strategy:
19+
fail-fast: false
20+
matrix:
21+
version:
22+
- '1.0'
23+
- '1'
24+
- 'nightly'
25+
os:
26+
- ubuntu-latest
27+
- macOS-latest
28+
- windows-latest
29+
arch:
30+
- x64
31+
- x86
32+
exclude:
33+
# 32-bit Julia binaries are not available on macOS
34+
- os: macOS-latest
35+
arch: x86
36+
- os: windows-latest
37+
arch: x86
38+
- version: nightly
39+
arch: x86
40+
steps:
41+
- uses: actions/checkout@v2
42+
- uses: julia-actions/setup-julia@latest
43+
with:
44+
version: ${{ matrix.version }}
45+
arch: ${{ matrix.arch }}
46+
- name: Cache artifacts
47+
uses: actions/cache@v2
48+
env:
49+
cache-name: cache-artifacts
50+
with:
51+
path: ~/.julia/artifacts
52+
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
53+
restore-keys: |
54+
${{ runner.os }}-test-${{ env.cache-name }}-
55+
${{ runner.os }}-test-
56+
${{ runner.os }}-
57+
- uses: julia-actions/julia-buildpkg@latest
58+
env:
59+
PYTHON: 'Conda'
60+
- uses: julia-actions/julia-runtest@latest
61+
- uses: julia-actions/julia-processcoverage@v1
62+
- uses: codecov/codecov-action@v1
63+
with:
64+
file: lcov.info
65+
docs:
66+
name: Documentation
67+
runs-on: ubuntu-latest
68+
steps:
69+
- uses: actions/checkout@v2
70+
- uses: julia-actions/setup-julia@latest
71+
with:
72+
version: '1'
73+
- name: Cache artifacts
74+
uses: actions/cache@v2
75+
env:
76+
cache-name: cache-artifacts
77+
with:
78+
path: ~/.julia/artifacts
79+
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/docs/Project.toml') }}
80+
restore-keys: |
81+
${{ runner.os }}-test-${{ env.cache-name }}-
82+
${{ runner.os }}-test-
83+
${{ runner.os }}-
84+
- uses: julia-actions/julia-buildpkg@latest
85+
env:
86+
PYTHON: 'Conda'
87+
- uses: julia-actions/julia-docdeploy@latest
88+
env:
89+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
90+
# Needed due to https://github.com/JuliaDocs/Documenter.jl/issues/1177
91+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
92+
GKSwstype: 'nul'

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.DS_Store
2+
*.jl.cov
3+
*.jl.*.cov
4+
*.jl.mem
5+
.ipynb_checkpoints
6+
.vscode
7+
Manifest.toml

‎LICENSE.md

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

‎Project.toml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name = "ForwardDiffPullbacks"
2+
uuid = "450a3b6d-2448-4ee1-8e34-e4eb8713b605"
3+
version = "0.1.0"
4+
5+
[deps]
6+
7+
[compat]
8+
julia = "1"
9+
10+
[extras]
11+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
12+
13+
[targets]
14+
test = ["Test"]

‎README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ForwardDiffPullbacks.jl
2+
3+
[![Documentation for stable version](https://img.shields.io/badge/docs-stable-blue.svg)](https://oschulz.github.io/ForwardDiffPullbacks.jl/stable)
4+
[![Documentation for development version](https://img.shields.io/badge/docs-dev-blue.svg)](https://oschulz.github.io/ForwardDiffPullbacks.jl/dev)
5+
[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md)
6+
[![Build Status](https://github.com/oschulz/ForwardDiffPullbacks.jl/workflows/CI/badge.svg?branch=master)](https://github.com/oschulz/ForwardDiffPullbacks.jl/actions?query=workflow%3ACI)
7+
[![Codecov](https://codecov.io/gh/oschulz/ForwardDiffPullbacks.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/oschulz/ForwardDiffPullbacks.jl)
8+
9+
10+
## Documentation
11+
12+
* [Documentation for stable version](https://oschulz.github.io/ForwardDiffPullbacks.jl/stable)
13+
* [Documentation for development version](https://oschulz.github.io/ForwardDiffPullbacks.jl/dev)

‎docs/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
build/
2+
site/

‎docs/Project.toml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
4+
5+
[compat]
6+
Documenter = "~0.26"

‎docs/make.jl

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Use
2+
#
3+
# DOCUMENTER_DEBUG=true julia --color=yes make.jl local [nonstrict] [fixdoctests]
4+
#
5+
# for local builds.
6+
7+
using Documenter
8+
using ForwardDiffPullbacks
9+
10+
makedocs(
11+
sitename = "ForwardDiffPullbacks",
12+
modules = [ForwardDiffPullbacks],
13+
format = Documenter.HTML(
14+
prettyurls = !("local" in ARGS),
15+
canonical = "https://oschulz.github.io/ForwardDiffPullbacks.jl/stable/"
16+
),
17+
pages = [
18+
"Home" => "index.md",
19+
"API" => "api.md",
20+
"LICENSE" => "LICENSE.md",
21+
],
22+
doctest = ("fixdoctests" in ARGS) ? :fix : true,
23+
linkcheck = !("nonstrict" in ARGS),
24+
strict = !("nonstrict" in ARGS),
25+
)
26+
27+
deploydocs(
28+
repo = "github.com/oschulz/ForwardDiffPullbacks.jl.git",
29+
forcepush = true,
30+
push_preview = true,
31+
)

‎docs/src/LICENSE.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# LICENSE
2+
3+
```@eval
4+
using Markdown
5+
Markdown.parse_file(joinpath(@__DIR__, "..", "..", "LICENSE.md"))
6+
```

‎docs/src/api.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# API
2+
3+
```@meta
4+
DocTestSetup = quote
5+
using ForwardDiffPullbacks
6+
end
7+
```
8+
9+
## Modules
10+
11+
```@index
12+
Order = [:module]
13+
```
14+
15+
## Types and constants
16+
17+
```@index
18+
Order = [:type, :constant]
19+
```
20+
21+
## Functions and macros
22+
23+
```@index
24+
Order = [:macro, :function]
25+
```
26+
27+
# Documentation
28+
29+
```@autodocs
30+
Modules = [ForwardDiffPullbacks]
31+
Order = [:module, :type, :constant, :macro, :function]
32+
```

‎docs/src/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# ForwardDiffPullbacks.jl

‎src/ForwardDiffPullbacks.jl

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# This file is a part of ForwardDiffPullbacks.jl, licensed under the MIT License (MIT).
2+
3+
__precompile__(true)
4+
5+
"""
6+
ForwardDiffPullbacks
7+
8+
Template for Julia packages.
9+
"""
10+
module ForwardDiffPullbacks
11+
12+
include("hello_world.jl")
13+
14+
end # module

‎src/hello_world.jl

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# This file is a part of ForwardDiffPullbacks.jl, licensed under the MIT License (MIT).
2+
3+
4+
"""
5+
ForwardDiffPullbacks.hello_world()
6+
7+
Prints "Hello, World!" and returns 42.
8+
9+
```jldoctest
10+
using ForwardDiffPullbacks
11+
12+
ForwardDiffPullbacks.hello_world()
13+
14+
# output
15+
16+
Hello, World!
17+
42
18+
```
19+
"""
20+
function hello_world()
21+
println("Hello, World!")
22+
return 42
23+
end

‎test/runtests.jl

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# This file is a part of ForwardDiffPullbacks.jl, licensed under the MIT License (MIT).
2+
3+
import Test
4+
5+
Test.@testset "Package ForwardDiffPullbacks" begin
6+
include("test_hello_world.jl")
7+
end # testset

‎test/test_hello_world.jl

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# This file is a part of ForwardDiffPullbacks.jl, licensed under the MIT License (MIT).
2+
3+
using ForwardDiffPullbacks
4+
using Test
5+
6+
7+
@testset "hello_world" begin
8+
@test ForwardDiffPullbacks.hello_world() == 42
9+
end

0 commit comments

Comments
 (0)