added docs and GitHub actions from Julia template

development
Martin Scheidt 2022-04-28 17:23:23 +02:00
parent e2842157da
commit 580e13f97b
7 changed files with 140 additions and 0 deletions

54
.github/workflows/CI.yml vendored Normal file
View File

@ -0,0 +1,54 @@
name: CI
on:
push:
branches:
- master
tags: '*'
pull_request:
concurrency:
# Skip intermediate builds: always.
# Cancel intermediate builds: only if it is a pull request build.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
version:
- '1.7'
- 'nightly'
os:
- ubuntu-latest
arch:
- x64
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: julia-actions/cache@v1
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-runtest@v1
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: '1'
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-docdeploy@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
- run: |
julia --project=docs -e '
using Documenter: DocMeta, doctest
using TrainRun
DocMeta.setdocmeta!(TrainRun, :DocTestSetup, :(using TrainRun); recursive=true)
doctest(TrainRun)'

16
.github/workflows/CompatHelper.yml vendored Normal file
View File

@ -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()'

15
.github/workflows/TagBot.yml vendored Normal file
View File

@ -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 }}

14
.github/workflows/register.yml vendored Normal file
View File

@ -0,0 +1,14 @@
name: Register Package
on:
workflow_dispatch:
inputs:
version:
description: Version to register or component to bump
required: true
jobs:
register:
runs-on: ubuntu-latest
steps:
- uses: julia-actions/RegisterAction@latest
with:
token: ${{ secrets.GITHUB_TOKEN }}

3
docs/Project.toml Normal file
View File

@ -0,0 +1,3 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
TrainRun = "e4541106-d44c-4e00-b50b-ecdf479fcf92"

24
docs/make.jl Normal file
View File

@ -0,0 +1,24 @@
using TrainRun
using Documenter
DocMeta.setdocmeta!(TrainRun, :DocTestSetup, :(using TrainRun); recursive=true)
makedocs(;
modules=[TrainRun],
authors="Max Kannenberg, Martin Scheidt, and contributors",
repo="https://github.com/railtoolkit/TrainRun.jl/blob/{commit}{path}#{line}",
sitename="TrainRun.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://railtoolkit.github.io/TrainRun.jl",
assets=String[],
),
pages=[
"Home" => "index.md",
],
)
deploydocs(;
repo="github.com/railtoolkit/TrainRun.jl",
devbranch="master",
)

14
docs/src/index.md Normal file
View File

@ -0,0 +1,14 @@
```@meta
CurrentModule = TrainRun
```
# TrainRun
Documentation for [TrainRun](https://github.com/railtoolkit/TrainRun.jl).
```@index
```
```@autodocs
Modules = [TrainRun]
```