#/
# @license Apache-2.0
#
# Copyright (c) 2021 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/

# Workflow name:
name: markdown-tocs

# Workflow triggers:
on:
  # Allow the workflow to be manually run:
  workflow_dispatch:

# Workflow jobs:
jobs:

  # Define a job for updating namespace table of contents in README.md files...
  update:

    # Define a display name:
    name: 'Update table of contents in README.md files'

    # Define the type of virtual host machine:
    runs-on: ubuntu-latest

    # Define the sequence of job steps...
    steps:

      # Checkout the repository:
      - name: 'Checkout repository'
        uses: actions/checkout@v2
        with:
          # Specify whether to remove untracked files before checking out the repository:
          clean: true

          # Limit clone depth to the most recent commit:
          fetch-depth: 1

          # Specify whether to download Git-LFS files:
          lfs: false
        timeout-minutes: 10

      # Install Node.js:
      - name: 'Install Node.js'
        uses: actions/setup-node@v2
        with:
          node-version: 'lts/*'
        timeout-minutes: 5

      # Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
      - name: 'Install dependencies'
        run: |
          make install-node-modules || make install-node-modules || make install-node-modules
        timeout-minutes: 15

      # Update namespace table of contents in README.md files:
      - name: 'Update tables of contents'
        run: |
          make markdown-namespace-tocs-files FILES="$( make list-pkgs-namespaces | sed 's/.*/lib\/node_modules\/&\/README.md/' | tr '\n' ' ' )"
          make markdown-pkg-urls-files FILES="$( make list-pkgs-namespaces | sed 's/.*/lib\/node_modules\/&\/README.md/' | tr '\n' ' ' )"

      # Create a pull request with the updated tables of contents:
      - name: 'Create pull request'
        uses: peter-evans/create-pull-request@v3
        with:
          title: 'Update namespace table of contents in README.md files'
          body: |
            This PR

            -   updates namespace table of contents in README.md files

            * * *

            @stdlib-js/reviewers

          commit-message: 'Update namespace table of contents in README.md files'
          committer: 'stdlib-bot <noreply@stdlib.io>'
          labels: |
            documentation
            automated-pr
          team-reviewers: |
            stdlib-reviewers
          branch: update-namespace-tocs
          delete-branch: true

Add workflow to update all table of contents
Add workflow to update all table of contents
