#/
# @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: repl_docs

# Workflow triggers:
on:
  pull_request:
    branches:
      - develop
    types:
      - closed
    paths:
      # List paths for which changes should trigger this workflow:
      - 'lib/**/namespace/lib/**'
      - 'lib/**/docs/repl.txt'

      # List paths for which changes should *not* trigger this workflow:
      - '!lib/**/_tools/**'

  # Allow the workflow to be manually run:
  workflow_dispatch:

# Workflow jobs:
jobs:

  # Define a job for updating REPL documentation...
  update:

    # Define a display name:
    name: 'Update REPL docs'

    # Only run this job if the pull request was merged:
    if: github.event.pull_request.merged == true

    # 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: '16' # '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

      # Initialize development environment:
      - name: 'Initialize development environment'
        run: |
          make init
        timeout-minutes: 5

      # Update REPL documentation:
      - name: 'Update documentation'
        run: |
          make repl-docs

      # Create a pull request with the updated documentation:
      - name: 'Create pull request'
        uses: peter-evans/create-pull-request@v3
        with:
          title: 'Update REPL namespace'
          body: |
            This PR

            -   updates the REPL namespace

          commit-message: 'Update REPL namespace'
          committer: 'stdlib-bot <noreply@stdlib.io>'
          labels: |
            documentation
            automated-pr
          team-reviewers: |
            stdlib-reviewers
          branch: update-repl-docs
          delete-branch: true