mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-12 17:26:19 +00:00
Add markdown linting (without breaking the site this time!)
This commit is contained in:
8
.github/pull_request_template.md
vendored
8
.github/pull_request_template.md
vendored
@@ -14,9 +14,11 @@
|
||||
|
||||
## Types of changes
|
||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||
<!-- ignore-task-list-start -->
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
<!-- ignore-task-list-end -->
|
||||
|
||||
## Checklist
|
||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||
@@ -24,10 +26,14 @@
|
||||
|
||||
- [ ] I have read the [contribution guide](https://geek-cookbook.funkypenguin.co.nz/community/contribute/#contributing-recipes)
|
||||
- [ ] The format of my changes matches that of other recipes (*ideally it was copied from [template](/manuscript/recipes/template.md)*)
|
||||
- [ ] I've added at least one footnote to my recipe (*Chef's Notes*)
|
||||
|
||||
<!--
|
||||
delete these next checks if not adding a new recipe
|
||||
-->
|
||||
|
||||
### Recipe-specific checks
|
||||
|
||||
- [ ] I've added at least one footnote to my recipe (*Chef's Notes*)
|
||||
- [ ] I've updated `common_links.md` in the `_snippets` directory and sorted alphabetically
|
||||
- [ ] I've updated the navigation in `mkdocs.yaml` in alphabetical order
|
||||
- [ ] I've updated `CHANGELOG.md` in reverse chronological order order
|
||||
|
||||
19
.github/workflows/markdownlint.yml
vendored
Normal file
19
.github/workflows/markdownlint.yml
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
name: 'Lint Markdown'
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize]
|
||||
|
||||
jobs:
|
||||
lint-markdown:
|
||||
name: Lint markdown
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Lint markdown files
|
||||
uses: docker://avtodev/markdown-lint:v1 # fastest way
|
||||
with:
|
||||
config: '.markdownlint.yaml'
|
||||
args: '**/*.md'
|
||||
ignore: '_snippets' # multiple files must be separated with single space
|
||||
24
.github/workflows/mkdocs-build-sanity-check.yml
vendored
Normal file
24
.github/workflows/mkdocs-build-sanity-check.yml
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
name: 'mkdocs sanity check'
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize]
|
||||
|
||||
jobs:
|
||||
mkdocs-sanity-check:
|
||||
name: Check mkdocs builds successfully
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Set up Python 3.8
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.8
|
||||
architecture: x64
|
||||
|
||||
- name: Install requirements
|
||||
run: python3 -m pip install -r requirements.txt
|
||||
|
||||
- name: Test mkdocs builds
|
||||
run: python3 -m mkdocs build
|
||||
6
.github/workflows/prune-stale-issues-prs.yml
vendored
6
.github/workflows/prune-stale-issues-prs.yml
vendored
@@ -10,6 +10,6 @@ jobs:
|
||||
- uses: actions/stale@v3
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
stale-issue-message: 'This issue has gone mouldy, because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days'
|
||||
days-before-stale: 30
|
||||
days-before-close: 5
|
||||
stale-issue-message: 'This issue has gone mouldy, because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days'
|
||||
days-before-stale: 90
|
||||
days-before-close: 14
|
||||
Reference in New Issue
Block a user