docs/.github/workflows/article-api-docs.yml at main · github/docs · GitHub

45 lines (36 loc) · 1.32 KB

name: 'Check article-api docs'

# **What it does**: Makes sure changes to the article api are documented.

# **Why we have it**: So what's documented doesn't fall behind

# **Who does it impact**: Docs engineering, CGS team

on:

workflow_dispatch:

pull_request:

paths:

- 'src/article-api/middleware/article.ts'

- 'src/article-api/middleware/pagelist.ts'

# Self-test

- .github/workflows/article-api-docs.yml

permissions:

contents: read

jobs:

check-content-linter-rules-docs:

runs-on: ubuntu-latest

if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'

steps:

- name: Checkout

uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

- uses: ./.github/actions/node-npm-setup

- name: Check that src/article-api/README.md is up-to-date

run: npm run generate-article-api-docs

- name: Fail if it isn't up-to-date

run: |

if [ -n "$(git status --porcelain)" ]; then

git status

git diff

# Some whitespace for the sake of the message below

echo ""

echo "src/article-api/README.md is out of date."

echo "Please run 'npm run generate-article-api-docs' and commit the changes."

exit 1;

Expand file tree