From f05e837e462e5d73d54be3389f3b2b0c18f268e8 Mon Sep 17 00:00:00 2001 From: Naveen Gogineni Date: Thu, 28 Nov 2024 15:49:18 -0500 Subject: [PATCH] Feat: Add new workflow for publish docs --- .github/workflows/publish-docs.yml | 62 ++++++++++++++++++++++++++++++ .github/workflows/test.yml | 49 ----------------------- 2 files changed, 62 insertions(+), 49 deletions(-) create mode 100644 .github/workflows/publish-docs.yml diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml new file mode 100644 index 0000000000..e236d35ff2 --- /dev/null +++ b/.github/workflows/publish-docs.yml @@ -0,0 +1,62 @@ +name: publish docs + +on: + push: + branches: + - main + tags: + - v3.* + +permissions: + contents: read + +jobs: + test-docs: + name: test-docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: stable + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version: latest + + - name: Set PATH + run: echo "${GITHUB_WORKSPACE}/.local/bin" >>"${GITHUB_PATH}" + + - run: make ensure-gfmrun + + - run: make gfmrun + env: + FLAGS: --walk docs/v3/ + + - run: make diffcheck + + publish: + permissions: + contents: write + if: startswith(github.ref, 'refs/tags/') + name: publish + needs: [test-docs] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - run: make ensure-mkdocs + env: + FLAGS: --upgrade-pip + + - run: make set-mkdocs-remote + env: + MKDOCS_REMOTE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - run: make deploy-mkdocs + \ No newline at end of file diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 49624f235f..3da78fcdb4 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -58,52 +58,3 @@ jobs: token: ${{ secrets.CODECOV_TOKEN }} fail_ci_if_error: true verbose: true - - test-docs: - name: test-docs - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - - name: Set up Go - uses: actions/setup-go@v5 - with: - go-version: stable - - - name: Set up Node.js - uses: actions/setup-node@v4 - with: - node-version: latest - - - name: Set PATH - run: echo "${GITHUB_WORKSPACE}/.local/bin" >>"${GITHUB_PATH}" - - - run: make ensure-gfmrun - - - run: make gfmrun - env: - FLAGS: --walk docs/v3/ - - - run: make diffcheck - - publish: - permissions: - contents: write - if: startswith(github.ref, 'refs/tags/') - name: publish - needs: [test-docs] - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - run: make ensure-mkdocs - env: - FLAGS: --upgrade-pip - - - run: make set-mkdocs-remote - env: - MKDOCS_REMOTE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - - run: make deploy-mkdocs