Skip to content

Commit 700a8b1

Browse files
e-duar-doe-duar-do
committed
added package files
1 parent 0b2f94c commit 700a8b1

File tree

10 files changed

+191
-0
lines changed

10 files changed

+191
-0
lines changed

‎.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+
- dev
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.6'
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 DynOptInterface
73+
DocMeta.setdocmeta!(DynOptInterface, :DocTestSetup, :(using DynOptInterface); recursive=true)
74+
doctest(DynOptInterface)

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

‎Project.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name = "DynOptInterface"
2+
uuid = "6c38235a-427b-4736-80fa-cf75909744ec"
3+
authors = ["Eduardo M. G. Vila <72969764+e-duar-do@users.noreply.github.com> and contributors"]
4+
version = "0.0.0"
5+
6+
[compat]
7+
julia = "1.6"
8+
9+
[extras]
10+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
11+
12+
[targets]
13+
test = ["Test"]

‎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+
DynOptInterface = "6c38235a-427b-4736-80fa-cf75909744ec"

‎docs/make.jl

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
using DynOptInterface
2+
using Documenter
3+
4+
DocMeta.setdocmeta!(DynOptInterface, :DocTestSetup, :(using DynOptInterface); recursive=true)
5+
6+
makedocs(;
7+
modules=[DynOptInterface],
8+
authors="Eduardo M. G. Vila <72969764+e-duar-do@users.noreply.github.com> and contributors",
9+
sitename="DynOptInterface.jl",
10+
format=Documenter.HTML(;
11+
canonical="https://JuDO-dev.github.io/DynOptInterface.jl",
12+
edit_link="dev",
13+
assets=String[],
14+
),
15+
pages=[
16+
"Home" => "index.md",
17+
],
18+
)
19+
20+
deploydocs(;
21+
repo="github.com/JuDO-dev/DynOptInterface.jl",
22+
devbranch="dev",
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 = DynOptInterface
3+
```
4+
5+
# DynOptInterface
6+
7+
Documentation for [DynOptInterface](https://github.com/JuDO-dev/DynOptInterface.jl).
8+
9+
```@index
10+
```
11+
12+
```@autodocs
13+
Modules = [DynOptInterface]
14+
```

‎src/DynOptInterface.jl

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

‎test/runtests.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
using DynOptInterface
2+
using Test
3+
4+
@testset "DynOptInterface.jl" begin
5+
# Write your tests here.
6+
end

0 commit comments

Comments
 (0)