Jd/maintenance

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: [1.3.0]
+        julia-arch: [x86]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v1.0.0
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia --project=docs --color=yes docs/make.jl

.travis.yml

@@ -1,6 +1,5 @@
 ## Documentation: http://docs.travis-ci.org/user/languages/julia/
 language: julia
-codecov: true
 os:
   - linux
   - osx
@@ -27,15 +26,6 @@ jobs:
   allow_failures:
     - julia: nightly
     - os: osx
-  include:
-    - stage: "Documentation"
-      os: linux
-      julia: 1.3
-      script:
-        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
-                                               Pkg.instantiate()'
-        - julia --project=docs/ docs/make.jl
-      after_success: skip
 after_success: julia -e '
   using Pkg;
   Pkg.add("Coverage");

Project.toml

@@ -1,6 +1,6 @@
 name = "LITS"
 uuid = "86b0dc02-7903-11e9-325f-f195ca7e6c1a"
-version = "0.3.0"
+version = "0.3.1"
 
 [deps]
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"

README.md

@@ -2,8 +2,10 @@
 Low Inertia Transient Simulation Toolbox for Power Systems
 
 [![Build Status](https://travis-ci.com/Energy-MAC/LITS.jl.svg?branch=master)](https://travis-ci.com/Energy-MAC/LITS.jl)
-[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://energy-mac.github.io/LITS.jl/latest)
 [![codecov](https://codecov.io/gh/Energy-MAC/LITS.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/Energy-MAC/LITS.jl)
+![Documentation Build](https://github.com/Energy-MAC/LITS.jl/workflows/Documentation/badge.svg)
+[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://energy-mac.github.io/LITS.jl/latest)
+
 
 To install and develop run the following:
 

codecov.yml

@@ -6,6 +6,20 @@ coverage:
   round: down
   range: "70...100"
 
+  status:
+    project:                   # measuring the overall project coverage
+      default:                 # context, you can create multiple ones with custom titles
+        enabled: yes           # must be yes|true to enable this status
+        target: auto           # specify the target coverage for each commit status
+                               #   option: "auto" (must increase from parent commit or pull request base)
+                               #   option: "X%" a static target percentage to hit
+        threshold: 5        # allowed to drop X% and still result in a "success" commit status
+        if_not_found: success  # if parent is not found report status as success, error, or failure
+        if_ci_failed: error    # if ci fails report status as success, error, or failure
+    patch:
+      default:
+        target: 70
+
 parsers:
   gcov:
     branch_detection:

docs/Project.toml

@@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
 
 [compat]
-Documenter = "0.23"
+Documenter = "0.24"

docs/make.jl

@@ -3,7 +3,7 @@ const PSYPATH = dirname(pathof(LITS))
 
 makedocs(
     modules = [LITS],
-    format = Documenter.HTML(),
+    format = Documenter.HTML(mathengine = Documenter.MathJax()),
     sitename = "LITS.jl",
     pages = Any[ # Compat: `Any` for 0.4 compat
         "Home" => "index.md",

src/LITS.jl

@@ -1,3 +1,4 @@
+isdefined(Base, :__precompile__) && __precompile__()
 module LITS
 
 ####################################### Structs Exports ####################################