We no longer need to generate man pages in it's own step.

It's part of the prepare-release step

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

.github/workflows/ci.yml

@@ -192,15 +192,6 @@ jobs:
     with:
       changed-files: ${{ needs.prepare-workflow.outputs.changed-files }}
 
-  docs:
-    name: Build Docs
-    if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['docs'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
-    uses: ./.github/workflows/docs-action.yml
-    needs:
-      - prepare-workflow
-    with:
-      changed-files: ${{ needs.prepare-workflow.outputs.changed-files }}
-
   lint:
     name: Lint
     if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['lint'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
@@ -220,6 +211,57 @@ jobs:
       cache-seed: ${{ needs.prepare-workflow.outputs.cache-seed }}
       salt-version: "${{ needs.prepare-workflow.outputs.salt-version }}"
 
+  docs:
+    name: Build Docs
+    if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['docs'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
+    runs-on: ubuntu-latest
+    container:
+      image: python:3.10-slim-buster
+    needs:
+      - prepare-workflow
+      - prepare-release
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download Release Changes
+        uses: actions/download-artifact@v3
+        with:
+          name: salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+
+      - name: Apply release changes
+        shell: bash
+        run: |
+          git apply salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+          rm salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+
+#      - 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
+
+      - name: Install Nox
+        run: |
+          python -m pip install --upgrade pip
+          pip install nox
+
+      - name: Install Python Requirements
+        run:
+          nox --install-only --forcecolor -e 'docs-html(compress=False, clean=True)'
+
+      - name: Build Docs
+        env:
+          SKIP_REQUIREMENTS_INSTALL: YES
+        run: |
+          nox --forcecolor -e 'docs-html(compress=False, clean=True)'
+
+      - name: Store Generated Documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: salt-html-docs
+          path: doc/_build/html
+          if-no-files-found: error
+
   build-source-tarball:
     name: Build Source Tarball
     if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['build-source-tarball'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
@@ -664,8 +706,8 @@ jobs:
     needs:
       - prepare-workflow
       - pre-commit
-      - docs
       - lint
+      - docs
       - build-deps-onedir
       - build-salt-onedir
       - build-pkgs

.github/workflows/docs-action.yml

@@ -1,102 +0,0 @@
-name: Docs
-
-on:
-  workflow_call:
-    inputs:
-      changed-files:
-        required: true
-        type: string
-        description: JSON string containing information about changed files
-
-
-env:
-  PIP_INDEX_URL: https://pypi-proxy.saltstack.net/root/local/+simple/
-  PIP_EXTRA_INDEX_URL: https://pypi.org/simple
-
-
-jobs:
-  Salt:
-    name: Build Salt Documentation
-    runs-on: ubuntu-latest
-    if: ${{ github.event_name == 'push' || github.event_name == 'schedule' || fromJSON(inputs.changed-files)['docs'] || fromJSON(inputs.changed-files)['salt'] }}
-
-    container:
-      image: python:3.8-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@v3
-        with:
-          fetch-depth: 0
-
-      - name: Install Nox
-        run: |
-          python -m pip install --upgrade pip
-          pip install nox
-
-      - name: Install Python Requirements
-        run:
-          nox --install-only --forcecolor -e 'docs-html(compress=False, clean=True)'
-
-      - name: Build Docs
-        env:
-          SKIP_REQUIREMENTS_INSTALL: YES
-        run: |
-          nox --forcecolor -e 'docs-html(compress=False, clean=True)'
-
-      - name: Store Generated Documentation
-        uses: actions/upload-artifact@v3
-        with:
-          name: salt-html-docs
-          path: doc/_build/html
-          if-no-files-found: error
-
-  Manpages:
-    name: Build Salt man Pages
-    runs-on: ubuntu-latest
-    if: ${{ github.event_name == 'push' || fromJSON(inputs.changed-files)['docs'] }}
-
-    container:
-      image: python:3.8-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
-          apt-get install -y git/buster-backports
-
-      - uses: actions/checkout@v3
-
-      - name: Install Nox
-        if: ${{ github.event_name == 'push' || fromJSON(inputs.changed-files)['docs'] }}
-        run: |
-          python -m pip install --upgrade pip
-          pip install nox
-
-      - name: Install Python Requirements
-        if: github.event_name == 'push' || fromJSON(inputs.changed-files)['docs']
-        run:
-          nox --install-only --forcecolor -e 'docs-man(compress=False, update=False, clean=True)'
-
-      - name: Build Manpages
-        if: github.event_name == 'push' || fromJSON(inputs.changed-files)['docs']
-        env:
-          SKIP_REQUIREMENTS_INSTALL: YES
-        run: |
-          nox --forcecolor -e 'docs-man(compress=False, update=False, clean=True)'
-
-      - name: Store Generated Documentation
-        if: github.event_name == 'push' || fromJSON(inputs.changed-files)['docs']
-        uses: actions/upload-artifact@v3
-        with:
-          name: salt-man-pages
-          path: doc/_build/man
-          if-no-files-found: error

.github/workflows/nightly.yml

@@ -190,15 +190,6 @@ jobs:
     with:
       changed-files: ${{ needs.prepare-workflow.outputs.changed-files }}
 
-  docs:
-    name: Build Docs
-    if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['docs'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
-    uses: ./.github/workflows/docs-action.yml
-    needs:
-      - prepare-workflow
-    with:
-      changed-files: ${{ needs.prepare-workflow.outputs.changed-files }}
-
   lint:
     name: Lint
     if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['lint'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
@@ -218,6 +209,57 @@ jobs:
       cache-seed: ${{ needs.prepare-workflow.outputs.cache-seed }}
       salt-version: "${{ needs.prepare-workflow.outputs.salt-version }}"
 
+  docs:
+    name: Build Docs
+    if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['docs'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
+    runs-on: ubuntu-latest
+    container:
+      image: python:3.10-slim-buster
+    needs:
+      - prepare-workflow
+      - prepare-release
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download Release Changes
+        uses: actions/download-artifact@v3
+        with:
+          name: salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+
+      - name: Apply release changes
+        shell: bash
+        run: |
+          git apply salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+          rm salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+
+#      - 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
+
+      - name: Install Nox
+        run: |
+          python -m pip install --upgrade pip
+          pip install nox
+
+      - name: Install Python Requirements
+        run:
+          nox --install-only --forcecolor -e 'docs-html(compress=False, clean=True)'
+
+      - name: Build Docs
+        env:
+          SKIP_REQUIREMENTS_INSTALL: YES
+        run: |
+          nox --forcecolor -e 'docs-html(compress=False, clean=True)'
+
+      - name: Store Generated Documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: salt-html-docs
+          path: doc/_build/html
+          if-no-files-found: error
+
   build-source-tarball:
     name: Build Source Tarball
     if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['build-source-tarball'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
@@ -710,8 +752,8 @@ jobs:
     needs:
       - prepare-workflow
       - pre-commit
-      - docs
       - lint
+      - docs
       - build-deps-onedir
       - build-salt-onedir
       - build-pkgs

.github/workflows/scheduled.yml

@@ -190,15 +190,6 @@ jobs:
     with:
       changed-files: ${{ needs.prepare-workflow.outputs.changed-files }}
 
-  docs:
-    name: Build Docs
-    if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['docs'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
-    uses: ./.github/workflows/docs-action.yml
-    needs:
-      - prepare-workflow
-    with:
-      changed-files: ${{ needs.prepare-workflow.outputs.changed-files }}
-
   lint:
     name: Lint
     if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['lint'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
@@ -218,6 +209,57 @@ jobs:
       cache-seed: ${{ needs.prepare-workflow.outputs.cache-seed }}
       salt-version: "${{ needs.prepare-workflow.outputs.salt-version }}"
 
+  docs:
+    name: Build Docs
+    if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['docs'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
+    runs-on: ubuntu-latest
+    container:
+      image: python:3.10-slim-buster
+    needs:
+      - prepare-workflow
+      - prepare-release
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download Release Changes
+        uses: actions/download-artifact@v3
+        with:
+          name: salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+
+      - name: Apply release changes
+        shell: bash
+        run: |
+          git apply salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+          rm salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+
+#      - 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
+
+      - name: Install Nox
+        run: |
+          python -m pip install --upgrade pip
+          pip install nox
+
+      - name: Install Python Requirements
+        run:
+          nox --install-only --forcecolor -e 'docs-html(compress=False, clean=True)'
+
+      - name: Build Docs
+        env:
+          SKIP_REQUIREMENTS_INSTALL: YES
+        run: |
+          nox --forcecolor -e 'docs-html(compress=False, clean=True)'
+
+      - name: Store Generated Documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: salt-html-docs
+          path: doc/_build/html
+          if-no-files-found: error
+
   build-source-tarball:
     name: Build Source Tarball
     if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['build-source-tarball'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
@@ -662,8 +704,8 @@ jobs:
     needs:
       - prepare-workflow
       - pre-commit
-      - docs
       - lint
+      - docs
       - build-deps-onedir
       - build-salt-onedir
       - build-pkgs

.github/workflows/templates/ci.yml.j2

@@ -24,22 +24,6 @@ on:
   <%- endif %>
 
 
-  <%- set job_name = "docs" %>
-  <%- if includes.get(job_name, True) %>
-
-  <{ job_name }>:
-    <%- do conclusion_needs.append(job_name) %>
-    name: Build Docs
-    if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['<{ job_name }>'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
-    uses: ./.github/workflows/docs-action.yml
-    needs:
-      - prepare-workflow
-    with:
-      changed-files: ${{ needs.prepare-workflow.outputs.changed-files }}
-
-  <%- endif %>
-
-
   <%- set job_name = "lint" %>
   <%- if includes.get(job_name, True) %>
 
@@ -72,6 +56,64 @@ on:
   <%- endif %>
 
 
+  <%- set job_name = "docs" %>
+  <%- if includes.get(job_name, True) %>
+
+  <{ job_name }>:
+    <%- do conclusion_needs.append(job_name) %>
+    name: Build Docs
+    if: ${{ fromJSON(needs.prepare-workflow.outputs.jobs)['<{ job_name }>'] && fromJSON(needs.prepare-workflow.outputs.runners)['github-hosted'] }}
+    runs-on: ubuntu-latest
+    container:
+      image: python:3.10-slim-buster
+    needs:
+      - prepare-workflow
+      - prepare-release
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download Release Changes
+        uses: actions/download-artifact@v3
+        with:
+          name: salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+
+      - name: Apply release changes
+        shell: bash
+        run: |
+          git apply salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+          rm salt-${{ needs.prepare-workflow.outputs.salt-version }}.diff
+
+#      - 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
+
+      - name: Install Nox
+        run: |
+          python -m pip install --upgrade pip
+          pip install nox
+
+      - name: Install Python Requirements
+        run:
+          nox --install-only --forcecolor -e 'docs-html(compress=False, clean=True)'
+
+      - name: Build Docs
+        env:
+          SKIP_REQUIREMENTS_INSTALL: YES
+        run: |
+          nox --forcecolor -e 'docs-html(compress=False, clean=True)'
+
+      - name: Store Generated Documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: salt-html-docs
+          path: doc/_build/html
+          if-no-files-found: error
+
+  <%- endif %>
+
+
   <%- set job_name = "build-source-tarball" %>
   <%- if includes.get(job_name, True) %>