ci: add publish documentation workflow update release workflow

Author: Bobbins228

.github/actions/publish-docs-action/publish-documentation.yaml

@@ -0,0 +1,41 @@
+name: Publish Documentation
+
+on:
+  workflow_dispatch:
+    inputs:
+      codeflare_sdk_release_version:
+        type: string
+        required: true
+        description: 'Version number (for example: 0.1.0)'
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: 1.8.3
+      - name: Create new documentation
+        run: |
+          python3 -m venv .venv
+          source .venv/bin/activate
+          poetry install --with docs
+          sed -i 's/release = "v[0-9]\+\.[0-9]\+\.[0-9]\+"/release = "${{ github.event.inputs.codeflare_sdk_release_version }}"/' docs/sphinx/conf.py
+          sphinx-apidoc -o docs/sphinx src/codeflare_sdk "**/*test_*" --force # Generate docs but ignore test files
+          make html -C docs/sphinx
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/sphinx/_build/html
+          force_orphan: true

.github/workflows/publish-documentation.yaml

@@ -0,0 +1,45 @@
+name: Publish Documentation
+
+on:
+  workflow_dispatch:
+    inputs:
+      codeflare_sdk_release_version:
+        type: string
+        required: true
+        description: 'Version number (for example: 0.1.0)'
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install Sphinx
+        run: |
+            sudo apt-get update
+            sudo apt-get install python3-sphinx
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: 1.8.3
+      - name: Create new documentation
+        run: |
+          python3 -m venv .venv
+          source .venv/bin/activate
+          poetry install --with docs
+          sed -i 's/release = "v[0-9]\+\.[0-9]\+\.[0-9]\+"/release = "${{ github.event.inputs.codeflare_sdk_release_version }}"/' docs/sphinx/conf.py
+          sphinx-apidoc -o docs/sphinx src/codeflare_sdk "**/*test_*" --force # Generate docs but ignore test files
+          make html -C docs/sphinx
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/sphinx/_build/html
+          force_orphan: true

.github/workflows/release.yaml

@@ -33,8 +33,6 @@ jobs:
         permissions:
             contents: write
             id-token: write  # This permission is required for trusted publishing
-        env:
-            PR_BRANCH_NAME: adjustments-release-${{ github.event.inputs.release-version }}
         steps:
             - name: Checkout the repository
               uses: actions/checkout@v4
@@ -51,36 +49,15 @@ jobs:
             - name: Run poetry install
               run: poetry install --with docs
             - name: Create new documentation
-              run: |
-                sphinx-apidoc -o docs/sphinx src/codeflare_sdk "**/*test_*" --force
-                make clean -C docs/sphinx
-                make html -C docs/sphinx
+              uses: ./.github/actions/publish-documentation
+              with:
+                codeflare_sdk_release_version: ${{ github.event.inputs.release-version }}
             - name: Copy demo notebooks into SDK package
               run: cp -r demo-notebooks src/codeflare_sdk/demo-notebooks
             - name: Run poetry build
               run: poetry build
-            - name: Commit changes in docs
-              uses: stefanzweifel/git-auto-commit-action@v4
-              with:
-                file_pattern: 'docs'
-                commit_message: "Changes in docs for release: v${{ github.event.inputs.release-version }}"
-                create_branch: true
-                branch: ${{ env.PR_BRANCH_NAME }}
-            - name: Create a PR with code changes
-              run: |
-                  if git branch -a | grep "${{ env.PR_BRANCH_NAME }}"; then
-                    GIT_BRANCH=${GITHUB_REF#refs/heads/}
-                    gh pr create --base "$GIT_BRANCH" --fill --head "${{ env.PR_BRANCH_NAME }}" --label "lgtm" --label "approved"
-                  fi
               env:
                 GITHUB_TOKEN: ${{ secrets.CODEFLARE_MACHINE_ACCOUNT_TOKEN }}
-            - name: Wait until PR with code changes is merged
-              run: |
-                  if git branch -a | grep "${{ env.PR_BRANCH_NAME }}"; then
-                    timeout 3600 bash -c 'until [[ $(gh pr view '${{ env.PR_BRANCH_NAME }}' --json state --jq .state) == "MERGED" ]]; do sleep 5 && echo "$(gh pr view '${{ env.PR_BRANCH_NAME }}' --json state --jq .state)"; done'
-                  fi
-              env:
-                GITHUB_TOKEN: ${{ github.TOKEN }}
             - name: Create Github release
               uses: ncipollo/release-action@v1
               with:

.gitignore

@@ -13,3 +13,4 @@ node_modules
 ui-tests/playwright-report
 ui-tests/test-results
 /src/codeflare_sdk.egg-info/
+docs/sphinx/_build