Repository navigation
Repo sync #15156
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: 'Content Lint Markdown' | |
| # Runs content linting on changed content and data files so style issues stay visible. | |
| on: | |
| pull_request: | |
| merge_group: | |
| workflow_dispatch: | |
| inputs: | |
| branch: | |
| description: The branch containing the changes we want to lint. | |
| required: true | |
| type: string | |
| default: main | |
| permissions: | |
| contents: read | |
| jobs: | |
| lint-content: | |
| if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repo | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| # Fetch two commits so changed-files can diff without extra API calls. | |
| fetch-depth: 2 | |
| - name: Set up Node and dependencies | |
| uses: ./.github/actions/node-npm-setup | |
| - name: Get changed content/data files | |
| id: changed_files | |
| uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 # v47.0.5 | |
| with: | |
| files: | | |
| content/** | |
| data/** | |
| - name: Print content linter annotations if changed content/data files | |
| if: steps.changed_files.outputs.any_modified == 'true' | |
| env: | |
| CHANGED_FILES: ${{ steps.changed_files.outputs.all_modified_files }} | |
| # Print annotations first because that command exits zero when it reports errors. | |
| # The next step fails the workflow with errors-only. | |
| run: npm run lint-content -- --print-annotations --paths $CHANGED_FILES | |
| - name: Run content linter if changed content/data files | |
| if: steps.changed_files.outputs.any_modified == 'true' | |
| env: | |
| CHANGED_FILES: ${{ steps.changed_files.outputs.all_modified_files }} | |
| run: npm run lint-content -- --errors-only --paths $CHANGED_FILES | |
| # Journey landing pages reference other articles by path in their frontmatter. | |
| # Moving or deleting one of those articles breaks the reference without touching | |
| # the landing page, so it never appears in the diff and GHD059 never runs on it. | |
| # The weekly full sweep catches it, but up to seven days late, and the article | |
| # loses its next/previous journey navigation the whole time. | |
| # | |
| # Check the landing pages on every run instead. Scoped to that one rule so a PR | |
| # can't be blocked by unrelated findings on pages it didn't touch, and left | |
| # ungated because deleting an article is one of the ways this breaks. | |
| - name: Check journey landing page guide paths | |
| run: | | |
| JOURNEY_PAGES=$(grep -rlE "^layout: *['\"]?journey-landing['\"]? *$" content/ || true) | |
| if [ -z "$JOURNEY_PAGES" ]; then | |
| echo "No journey landing pages found, nothing to check." | |
| exit 0 | |
| fi | |
| npm run lint-content -- --rules journey-tracks-guide-path-exists --paths $JOURNEY_PAGES |