.Circleci/Config.Yml (.circleci/config.yml)
version: 2
jobs:
docs-build:
docker:
- image: ruby:2.6
steps:
- checkout
- run:
name: Install AsciiDoctor & Rouge
command: |
gem install asciidoctor
gem install rouge -v 3.3.0
- run:
name: Build Site
command: asciidoctor -a toc="left" -a toclevels=2 README.adoc -o _build/html/index.html
- persist_to_workspace:
root: _build
paths: html
docs-deploy:
docker:
- image: node:8.10.0
steps:
- checkout
- attach_workspace:
at: _build
- run:
name: Disable jekyll builds
command: touch _build/html/.nojekyll
- run:
name: Install and configure dependencies
command: |
npm install --silent [email protected]
git config user.email "[email protected]"
git config user.name "ci-build"
- add_ssh_keys:
fingerprints:
- "e4:5b:5f:9b:26:ad:46:71:8d:30:b7:12:3c:0a:57:2d"
- run:
name: Deploy docs to gh-pages branch
command: gh-pages -add --dotfiles --message "[skip ci] Update site" --dist _build/html
workflows:
version: 2
build:
jobs:
- docs-build
- docs-deploy:
requires:
- docs-build
filters:
branches:
only: master
---
.Github/Dependabot.Yml (.github/dependabot.yml)
version: 2
updates:
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'weekly'
---
.Github/Workflows/Spell Checking.Yml (.github/workflows/spell_checking.yml)
name: Spell Checking
on: [pull_request]
jobs:
codespell:
name: Check spelling with codespell
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.8]
steps:
- uses: actions/checkout@v7
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v7
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install codespell
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Check spelling with codespell
run: codespell --ignore-words=codespell.txt || exit 1
misspell:
name: Check spelling with misspell
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- name: Install
run: wget -O - -q https://raw.githubusercontent.com/client9/misspell/master/install-misspell.sh | sh -s -- -b .
- name: Misspell
run: ./misspell -error
---