doc.yml

# Authors:
#   Unai Martinez-Corral
#
# Copyright 2020-2021 Unai Martinez-Corral <unai.martinezcorral@ehu.eus>
#
# 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.
#
# SPDX-License-Identifier: Apache-2.0

name: 'doc'

on:
  pull_request:
  push:
    paths:
      - '.github/workflows/doc.yml'
      - 'doc/**'
      - 'graph/**'
  schedule:
    - cron: '0 0 * * 4'
  workflow_dispatch:
  repository_dispatch:
    types: [ doc ]

env:
  DOCKER_BUILDKIT: 1

jobs:

  asciidoc:
    runs-on: ubuntu-latest
    steps:

    - uses: actions/checkout@v2

    - name: Build hdlc/doc images
      run: make -C doc asciidoctor-py pyHDLC

    - name: Build site
      run: |
        make -C doc
        make -C doc map

    - name: Publish site to gh-pages (doc)
      if: github.event_name != 'pull_request' && github.repository == 'hdl/containers'
      run: |
        sudo chown -R $USER:$USER doc/public
        mv doc/public ./
        cd public
        git init
        cp ../.git/config ./.git/config
        touch .nojekyll
        mv ../utils/pyHDLC/map.svg ./img/
        git add .
        git config --local user.email "push@gha"
        git config --local user.name "GHA"
        git commit -am "update ${{ github.sha }}"
        git push -u origin +HEAD:gh-pages

    - name: Login to docker.io
      if: github.event_name != 'pull_request' && github.repository == 'hdl/containers'
      uses: docker/login-action@v1
      with:
        username: ${{ secrets.DOCKER_USER }}
        password: ${{ secrets.DOCKER_PASS }}

    - if: github.event_name != 'pull_request' && github.repository == 'hdl/containers'
      run: |
        docker push hdlc/doc:asciidoctor-py
        docker push hdlc/doc:pyHDLC