weekly-checks.yml

# This code is a Qiskit project.
#
# (C) Copyright IBM 2024.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

name: Weekly checks
on:
  workflow_dispatch:
  schedule:
    - cron: "0 0 * * 0" # Every Sunday at midnight UTC

jobs:
  pages-render:
    runs-on: ubuntu-latest
    if: github.repository_owner == 'Qiskit'
    steps:
      - uses: actions/checkout@v4
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: 18
      - name: Install Node.js dependencies
        run: npm ci
      - name: Start local Docker preview
        run: |
          ./start &
          sleep 20
      - name: Check all pages render
        run: >
          npm run check:pages-render --
          --non-api
          --qiskit-release-notes
          --current-apis
          --dev-apis
          --historical-apis

  external-link-checker:
    runs-on: ubuntu-latest
    if: github.repository_owner == 'Qiskit'
    steps:
      - uses: actions/checkout@v4
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: 18
      - name: Install Node.js dependencies
        run: npm ci
      - name: Check external links
        env:
          GITHUB_TOKEN: ${{ github.token }}
        run: >
          npm run check:external-links --
          'docs/**/*.{md,mdx,ipynb}'
          '!docs/api/qiskit/[0-9]*/*'

  make_issue:
    name: Make issue on failure
    needs: [external-link-checker, pages-render]
    if: ${{ failure() && github.event_name == 'schedule' }}
    runs-on: ubuntu-latest
    steps:
      - name: Post issue
        uses: actions/github-script@v7
        with:
          script: |
            const message = `Today's scheduled extended checks failed.

            Please [check the logs](https://github.com/Qiskit/documentation/actions/runs/${{ github.run_id }}/).

            > [!NOTE]
            > This issue was created by a GitHub action.
            `

            github.rest.issues.create({
              owner: context.repo.owner,
              repo: context.repo.repo,
              title: "Extended checks failed",
              body: message,
              assignees: ["frankharkins", "Eric-Arellano", "arnaucasau"]
            })