release.yml

name: Generate Release Docs

on:
  workflow_dispatch:
    inputs:
      saltVersion:
        description: 'Salt Version'
        required: true
      manPages:
        description: "Build Man Pages"
        default: true
        required: false

permissions:
  contents: read

jobs:
  SaltChangelog:
    permissions:
      contents: read  # for dorny/paths-filter to fetch a list of changed files
      pull-requests: read  # for dorny/paths-filter to read pull requests
    name: Build Salt Changelog
    runs-on: ubuntu-latest

    container:
      image: python:3.8.6-slim-buster

    steps:

    - name: Install System Deps
      run: |
        echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list
        apt-get update
        apt-get install -y enchant git gcc imagemagick make zlib1g-dev libc-dev libffi-dev g++ libxml2 libxml2-dev libxslt-dev libcurl4-openssl-dev libssl-dev libgnutls28-dev xz-utils
        apt-get install -y git/buster-backports

    - uses: actions/checkout@v2
      with:
        fetch-depth: 0

    - name: Install Nox
      env:
        PIP_EXTRA_INDEX_URL: https://pypi-proxy.saltstack.net/root/local/+simple/
      run: |
        python -m pip install --upgrade pip
        pip install nox

    - id: changed-files
      name: Get Changed Files
      uses: dorny/paths-filter@v2
      with:
        token: ${{ github.token }}
        list-files: json
        filters: |
          docs:
            - doc/**

    - name: Install Python Requirements
      env:
        PIP_EXTRA_INDEX_URL: https://pypi-proxy.saltstack.net/root/local/+simple/
      run: |
        nox --install-only --forcecolor -e 'changelog(force=True, draft=False)' -- ${{ github.event.inputs.saltVersion }}
        nox --install-only --forcecolor -e 'changelog(force=False, draft=True)' -- ${{ github.event.inputs.saltVersion }}

    - name: Build Changelog
      env:
        SKIP_REQUIREMENTS_INSTALL: YES
      run: |
        nox --forcecolor -e 'changelog(force=False, draft=True)' -- ${{ github.event.inputs.saltVersion }} > rn_changelog
        nox --forcecolor -e 'changelog(force=True, draft=False)' -- ${{ github.event.inputs.saltVersion }}
        git restore --staged changelog/
        git diff --no-color > rm_changelog_patch.txt

    - name: Store Generated Changelog
      uses: actions/upload-artifact@v2
      with:
        name: salt-changelog
        path: |
          CHANGELOG.md
          rm_changelog_patch.txt
          rn_changelog

  Manpages:
    permissions:
      contents: read  # for dorny/paths-filter to fetch a list of changed files
      pull-requests: read  # for dorny/paths-filter to read pull requests
    name: Build Salt man Pages
    runs-on: ubuntu-latest

    container:
      image: python:3.8.6-slim-buster

    steps:

    - name: Install System Deps
      if: github.event.inputs.manPages == 'true'
      run: |
        echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list
        apt-get update
        apt-get install -y enchant git gcc imagemagick make zlib1g-dev libc-dev libffi-dev g++ libxml2 libxml2-dev libxslt-dev libcurl4-openssl-dev libssl-dev libgnutls28-dev
        apt-get install -y git/buster-backports

    - uses: actions/checkout@v2

    - id: changed-files
      if: github.event.inputs.manPages == 'true'
      name: Get Changed Files
      uses: dorny/paths-filter@v2
      with:
        token: ${{ github.token }}
        list-files: json
        filters: |
          docs:
            - doc/**

    - name: Install Nox
      if: github.event.inputs.manPages == 'true'
      env:
        PIP_EXTRA_INDEX_URL: https://pypi-proxy.saltstack.net/root/local/+simple/
      run: |
        python -m pip install --upgrade pip
        pip install nox

    - name: Install Python Requirements
      if: github.event.inputs.manPages == 'true'
      env:
        PIP_EXTRA_INDEX_URL: https://pypi-proxy.saltstack.net/root/local/+simple/
      run:
        nox --install-only --forcecolor -e 'docs-man(compress=False, update=True, clean=True)'

    - name: Build Manpages
      if: github.event.inputs.manPages == 'true'
      env:
        SKIP_REQUIREMENTS_INSTALL: YES
      run: |
        nox --forcecolor -e 'docs-man(compress=False, update=True, clean=True)'

    - name: Store Generated Documentation
      if: github.event.inputs.manPages == 'true'
      uses: actions/upload-artifact@v2
      with:
        name: salt-man-pages
        path: doc/_build/man

  PullRequest:
    permissions:
      contents: write  # for peter-evans/create-pull-request to create branch
      pull-requests: write  # for peter-evans/create-pull-request to create a PR
    needs: [SaltChangelog, Manpages]
    name: Create Pull Request
    runs-on: ubuntu-latest

    container:
      image: python:3.8.6-slim-buster

    steps:
    - name: Install System Deps
      run: |
        echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list
        apt-get update
        apt-get install -y enchant git gcc imagemagick make zlib1g-dev libc-dev libffi-dev g++ libxml2 libxml2-dev libxslt-dev libcurl4-openssl-dev libssl-dev libgnutls28-dev xz-utils
        apt-get install -y git/buster-backports

    - uses: actions/checkout@v2
      with:
        fetch-depth: 0

    - name: Download salt-man-pages
      if: github.event.inputs.manPages == 'true'
      uses: actions/download-artifact@v2
      with:
        name: salt-man-pages
        path: doc/man/

    - name: Download salt changelog
      uses: actions/download-artifact@v2
      with:
        name: salt-changelog

    - name: Generate Release Notes and changelog
      run: |
       git apply rm_changelog_patch.txt
       rm rm_changelog_patch.txt
       sed -i '0,/^======/d' rn_changelog
       cat rn_changelog
       cat rn_changelog >> doc/topics/releases/${{ github.event.inputs.saltVersion }}.rst
       rm rn_changelog

    - name: Create Pull Request for Release
      uses: peter-evans/create-pull-request@v3
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        commit-message: Add changelog and docs for ${{ github.event.inputs.saltVersion }} release
        title: 'Generate Salt Man Page and Changelog'
        body: >
          This PR is auto-generated by
          [create-pull-request](https://github.com/peter-evans/create-pull-request).
        branch: docs_${{ github.event.inputs.saltVersion }}