From 580e13f97b5b0d97fe85916c397a30e951535682 Mon Sep 17 00:00:00 2001
From: Martin Scheidt <m.scheidt@tu-bs.de>
Date: Thu, 28 Apr 2022 17:23:23 +0200
Subject: [PATCH] added docs and GitHub actions from Julia template

---
 .github/workflows/CI.yml           | 54 ++++++++++++++++++++++++++++++
 .github/workflows/CompatHelper.yml | 16 +++++++++
 .github/workflows/TagBot.yml       | 15 +++++++++
 .github/workflows/register.yml     | 14 ++++++++
 docs/Project.toml                  |  3 ++
 docs/make.jl                       | 24 +++++++++++++
 docs/src/index.md                  | 14 ++++++++
 7 files changed, 140 insertions(+)
 create mode 100644 .github/workflows/CI.yml
 create mode 100644 .github/workflows/CompatHelper.yml
 create mode 100644 .github/workflows/TagBot.yml
 create mode 100644 .github/workflows/register.yml
 create mode 100644 docs/Project.toml
 create mode 100644 docs/make.jl
 create mode 100644 docs/src/index.md

diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
new file mode 100644
index 0000000..68202e0
--- /dev/null
+++ b/.github/workflows/CI.yml
@@ -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)'
diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml
new file mode 100644
index 0000000..cba9134
--- /dev/null
+++ b/.github/workflows/CompatHelper.yml
@@ -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()'
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
new file mode 100644
index 0000000..f49313b
--- /dev/null
+++ b/.github/workflows/TagBot.yml
@@ -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 }}
diff --git a/.github/workflows/register.yml b/.github/workflows/register.yml
new file mode 100644
index 0000000..6e71f2f
--- /dev/null
+++ b/.github/workflows/register.yml
@@ -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 }}
diff --git a/docs/Project.toml b/docs/Project.toml
new file mode 100644
index 0000000..b513025
--- /dev/null
+++ b/docs/Project.toml
@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+TrainRun = "e4541106-d44c-4e00-b50b-ecdf479fcf92"
diff --git a/docs/make.jl b/docs/make.jl
new file mode 100644
index 0000000..4b52efb
--- /dev/null
+++ b/docs/make.jl
@@ -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",
+)
diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 0000000..217d810
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,14 @@
+```@meta
+CurrentModule = TrainRun
+```
+
+# TrainRun
+
+Documentation for [TrainRun](https://github.com/railtoolkit/TrainRun.jl).
+
+```@index
+```
+
+```@autodocs
+Modules = [TrainRun]
+```