Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs linter on Markdown files only #456

Merged
merged 7 commits into from
May 31, 2024
Merged

Docs linter on Markdown files only #456

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
514fb2e
docs linter only on markdown files
louiseschmidtgen May 31, 2024
2eb66a4
add gh runner top level permissions
louiseschmidtgen May 31, 2024
eda9ce6
test docs linter within docs
louiseschmidtgen May 31, 2024
3e59b32
cleanup
louiseschmidtgen May 31, 2024
ac9d61e
linter works so do as it says
louiseschmidtgen May 31, 2024
bf27186
test if ignore files works
louiseschmidtgen May 31, 2024
8eedd03
cleanup
louiseschmidtgen May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions .github/workflows/markdown.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@ name: "Docs: Markdown lint"

on: [push, pull_request]

permissions:
contents: read

jobs:
markdown-lint:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v44
id: changed-files
with:
files: |
docs/src/snap/**
docs/src/charm/**
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-files.outputs.any_changed == 'true'
with:
config: 'docs/src/.markdownlint.json'
globs: ${{ steps.changed-files.outputs.all_changed_files }}
separator: ","


- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v44
id: changed-markdown-files
with:
files: |
**.md
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-markdown-files.outputs.any_changed == 'true'
with:
config: "docs/src/.markdownlint.json"
globs: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
separator: ","
Loading