Skip to content

Commit

Permalink
Merge pull request #98 from rhys-newbury/rhys/chain
Browse files Browse the repository at this point in the history
Major Updates
  • Loading branch information
tgdwyer authored Jul 4, 2024
2 parents 6af19dd + 7690431 commit 2316955
Show file tree
Hide file tree
Showing 42 changed files with 3,489 additions and 1,195 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/build-jekyll.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Build and Deploy to Github Pages

on:
push:
branches:
- master # Here source code branch is `master`, it could be other branch

jobs:
build_and_deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

# Use GitHub Actions' cache to cache dependencies on servers
- uses: actions/cache@v4
with:
path: |
.asdf/**
vendor/bundle
key: ${{ runner.os }}-cache-${{ hashFiles('**/cache.key') }}
restore-keys: |
${{ runner.os }}-cache-
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.8'

- name: Generate Glossary
run: python scripts/generate_glossary.py

# Use GitHub Deploy Action to build and deploy to Github
# For latest version: `jeffreytse/jekyll-deploy-action@master`
- uses: jeffreytse/[email protected]
with:
provider: 'github' # Default is github
token: ${{ secrets.GITHUB_TOKEN }} # It's your Personal Access Token(PAT)
ssh_private_key: '' # It's your SSH private key (SSH approach)
repository: '' # Default is current repository
branch: 'gh-pages' # Default is gh-pages for github provider
jekyll_src: './' # Default is root directory
jekyll_cfg: '_config.yml' # Default is _config.yml
jekyll_baseurl: '' # Default is according to _config.yml
ruby_ver: '' # Default is 3.2.0 version
bundler_ver: '' # Default is compatible bundler version (~>2.5.0)
cname: '' # Default is to not use a cname
actor: '' # Default is the GITHUB_ACTOR
pre_build_commands: '' # Installing additional dependencies (Arch Linux)
41 changes: 41 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Lint Checks

on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
lint:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: "18"

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.10"

- name: Install markdownlint-cli
run: npm install -g markdownlint-cli

- name: Install codespell
run: pip install codespell

- name: Run markdownlint
run: |
markdownlint '**/*.md' --fix --disable MD013 MD033 MD051 MD025 MD024 MD028
- name: Run codespell
run: |
codespell -I custom_words.txt --exclude-file=Gemfile.lock
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
_site
.sass-cache
.jekyll-metadata
.jekyll-cache
24 changes: 24 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
repos:
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.41.0
hooks:
- id: markdownlint
args:
[
--fix,
--disable=MD013,
--disable=MD033,
--disable=MD051,
--disable=MD025,
--disable=MD024,
--disable=MD028,
]
- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
args:
[
-I custom_words.txt,
--exclude-file=Gemfile.lock
]
9 changes: 6 additions & 3 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@ source "https://rubygems.org"
# Update gems: bundle install
# Run Jekyll: bundle exec jekyll serve

group :jekyll_plugins do
gem "github-pages"
end
gem "minima"
gem "jekyll", "~> 4.2.0"
gem "jekyll-feed", "~> 0.12"
gem "jekyll-sitemap", "~> 1.4"
gem "jekyll-sass-converter", "~> 2.1"
gem "nokogiri"

gem "webrick" # Local server

Expand Down
Loading

0 comments on commit 2316955

Please sign in to comment.