docs/.github/workflows/link-check-github-github.yml at main · github/docs · GitHub

View runs

History

84 lines (72 loc) · 3.04 KB

Raw

name: 'Link Check: github/github'

# **What it does**: This checks for any broken docs.github.com links in github/github

# **Why we have it**: Make sure all docs in github/github are up to date

# **Who does it impact**: Docs engineering, people on GitHub

on:

workflow_dispatch:

schedule:

- cron: '20 16 * * 1' # Run every Monday at 16:20 UTC / 8:20 PST

permissions:

contents: read

jobs:

check_github_github_links:

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

runs-on: ubuntu-latest

env:

REPORT_AUTHOR: docs-bot

REPORT_LABEL: github github broken link report,workflow-generated

REPORT_REPOSITORY: github/docs-content

steps:

- name: Checkout

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

with:

# To prevent issues with cloning early access content later

persist-credentials: 'false'

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

- uses: ./.github/actions/get-docs-early-access

with:

token: ${{ secrets.DOCS_BOT_PAT_BASE }}

- name: Build server

run: npm run build

- name: Start server in the background

env:

NODE_ENV: production

PORT: 4000

ENABLED_LANGUAGES: en

run: |

npm run start-for-ci &

sleep 5

curl --retry-connrefused --retry 5 -I http://localhost:4000/

- name: Run broken github/github link check

env:

# Needs a token with access to github/github; the app token is scoped to it above

GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}

run: |

npm run check-github-github-links -- broken_github_github_links.md

- name: Get title for issue

# If the file 'broken_github_github_links.md' got created,

# the hash of it will not be an empty string. That means if found

# broken links, we want to create an issue.

if: ${{ hashFiles('broken_github_github_links.md') != '' }}

id: check

run: echo "title=$(head -1 broken_github_github_links.md)" >> $GITHUB_OUTPUT

- name: Create issue from file

if: ${{ hashFiles('broken_github_github_links.md') != '' }}

id: github-github-broken-link-report

uses: peter-evans/create-issue-from-file@fca9117c27cdc29c6c4db3b86c48e4115a786710

with:

token: ${{ secrets.DOCS_BOT_PAT_BASE }}

title: ${{ steps.check.outputs.title }}

content-filepath: ./broken_github_github_links.md

repository: ${{ env.REPORT_REPOSITORY }}

labels: ${{ env.REPORT_LABEL }}

- uses: ./.github/actions/create-workflow-failure-issue

id: create-failure-issue

if: ${{ failure() && github.event_name != 'workflow_dispatch' }}

with:

token: ${{ secrets.DOCS_BOT_PAT_BASE }}

- uses: ./.github/actions/slack-alert

if: ${{ failure() && github.event_name != 'workflow_dispatch' }}

with:

slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}

issue_url: ${{ steps.create-failure-issue.outputs.issue_url }}

docs/.github/workflows/link-check-github-github.yml at main · github/docs · GitHub

Uh oh!

Expand file tree

Breadcrumbs

link-check-github-github.yml

Latest commit

History

Breadcrumbs

link-check-github-github.yml

File metadata and controls