Skip to content

Markdown

Markdown #502

Workflow file for this run

---
name: Markdown
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
on:
push:
branches:
- main
pull_request:
branches:
- main
types:
- opened
- synchronize
- reopened
merge_group:
schedule:
- cron: "0 14 * * 1" # every monday at 9 in the morning CST
workflow_dispatch:
env:
CI: true
permissions: # added using https://github.com/step-security/secure-repo
contents: read
jobs:
spell-check:
name: Check Spelling
needs: []
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/spell_check.yml@618f3e0c6fa813565957c17288047161ea32e3a2 # v1.13.0
with:
includes: |
**/*.md
# **/*.dart
**/*.yaml
**/*.toml
modified_files_only: false
config: cspell.json
link-check:
name: Check Links
needs: []
timeout-minutes: 2
runs-on: ubuntu-latest
steps:
- name: 🪄 Link Check
uses: gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec # 1.0.15
with:
use-quiet-mode: "yes"
use-verbose-mode: "yes"
base-branch: "main"
markdownlint:
name: Lint Markdown
needs: []
timeout-minutes: 4
runs-on: ubuntu-latest
steps:
- name: 📚 Git Checkout
uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
with:
submodules: true
- name: 🪄 Markdown Linting
uses: DavidAnson/markdownlint-cli2-action@8f3516061301755c97ff833a8e933f09282cc5b5 # v11.0.0
id: markdownlint
with:
fix: true
globs: |
**/*.md
continue-on-error: true
- name: ⚙️ Make PR
uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 # v5.0.2
if: ${{ github.event_name == 'pull_request' }}
with:
commit-message: "chore: apply markdownlint fxes"
branch: fixes/${{ github.head_ref }}
base: ${{ github.head_ref }}
title: "Apply markdownlint fixes for ${{ github.event.pull_request.title }}"
body: "*This is an automated pull request because markdownlint found problems that could be fixed automatically.*"
reviewers: lishaduck
assignees: lishaduck
signoff: true
delete-branch: true