Skip to content

Commit 073020d

Browse files
committed
Initial commit
1 parent a76d313 commit 073020d

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

.github/workflows/markdownlint.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
# This action performs a lint of markdown files in the repository
3+
4+
# Name of the action
5+
name: Markdown Linting
6+
7+
# Events which trigger the action
8+
on:
9+
push:
10+
pull_request:
11+
workflow_dispatch:
12+
13+
jobs:
14+
markdownlint:
15+
name: Lint markdown (.md) files
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
# checkout@v2 action documentation
20+
# https://github.com/marketplace/actions/checkout
21+
- name: Checkout repository
22+
uses: actions/checkout@v2
23+
24+
# markdownlint-cli action documentation
25+
# https://github.com/marketplace/actions/markdownlint-cli
26+
- name: markdownlint-cli
27+
uses: nosborn/[email protected]
28+
with:
29+
files: .
30+
config_file: .markdownlint.json

.github/workflows/mkdocs-build.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
# Build Documentation with MkDocs
3+
name: Build Documentation w/ MkDocs
4+
5+
# Controls when the action will run.
6+
on:
7+
# Triggers the workflow on push events but only for the main branch
8+
push:
9+
branches:
10+
- main
11+
12+
# Allows you to run this workflow manually from the Actions tab
13+
workflow_dispatch:
14+
15+
jobs:
16+
build:
17+
name: build and deploy
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- uses: actions/checkout@v2
22+
with:
23+
ref: ${{ github.event.pull_request.head.ref }}
24+
submodules: recursive
25+
26+
- name: Set up Python3
27+
uses: actions/setup-python@v2
28+
with:
29+
python-version: '3.x'
30+
31+
- uses: actions/cache@v2
32+
with:
33+
path: ~/.cache/pip
34+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }}
35+
restore-keys: |
36+
${{ runner.os }}-pip-
37+
38+
- name: Install dependencies
39+
run: |
40+
python -m pip install --upgrade pip
41+
python -m pip install -r requirements.txt
42+
43+
- name: Deploy
44+
run: |
45+
git pull
46+
mkdocs gh-deploy

0 commit comments

Comments
 (0)