feat: update workflows to support docs versioning

Author: heitorlessa

.github/workflows/publish.yml

@@ -31,6 +31,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
     - name: Set up Python
       uses: actions/setup-python@v1
       with:
@@ -68,7 +70,21 @@ jobs:
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
         AWS_DEFAULT_REGION: eu-west-1
         AWS_DEFAULT_OUTPUT: json
-
+    - name: Setup doc deploy
+      run: |
+        git config --global user.name Docs deploy
+        git config --global user.email docs@dummy.bot.com
+    - name: Build docs website and API reference
+      run: make release-docs VERSION=${RELEASE_TAG_VERSION} ALIAS="latest"
+    - name: Update docs redirects
+      run: poetry run mike set-default --push latest
+    - name: Deploy all docs
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./api
+        keep_files: true
+        destination_dir: develop/api
 
 
   sync_master:

.github/workflows/python_docs.yml

@@ -1,59 +1,38 @@
 name: Docs
 
 on:
-  pull_request:
-    branches:
-      - master
   push:
     branches:
-      - master
-      - docs/mkdocs
-      # Disabled until docs support versioning per branch/release
-      # - develop
-  release:
-    types: [published] # update Docs upon new release
+      - develop
 
 jobs:
   api-docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
           python-version: "3.8"
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '12'
       - name: Capture branch and tag
         id: branch_name
         run: |
           echo "SOURCE_BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
           echo "SOURCE_TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
-      - name: Build docs website
-        run: make build-docs-website
-      - name: Build docs API reference
-        # if: env.SOURCE_BRANCH == 'master' # Disabled until docs support versioning per branch/release
-        run: make build-docs-api
+      - name: Install dependencies
+        run: make dev
+      - name: Setup doc deploy
+        run: |
+          git config --global user.name Docs deploy
+          git config --global user.email docs@dummy.bot.com
+      - name: Build docs website and API reference
+        run: make release-docs VERSION="develop" ALIAS="stage"
       - name: Deploy all docs
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./dist
-
-      # Disabled until docs support versioning per branch/release
-      # - name: Deploy docs website
-      #   uses: peaceiris/actions-gh-pages@v3
-      #   with:
-      #     github_token: ${{ secrets.GITHUB_TOKEN }}
-      #     publish_dir: ./dist
-      #     # when deploying docs website only
-      #     # we need to keep existing API docs checked in
-      #     # but only for dev branch
-      #     keep_files: true
-      # - name: Deploy all docs
-      #   uses: peaceiris/actions-gh-pages@v3
-      #   if: env.SOURCE_BRANCH == 'master'
-      #   with:
-      #     github_token: ${{ secrets.GITHUB_TOKEN }}
-      #     publish_dir: ./dist
+          publish_dir: ./api
+          keep_files: true
+          destination_dir: develop/api

Makefile

@@ -28,20 +28,18 @@ pr: lint test security-baseline complexity-baseline
 build: pr
 	poetry build
 
-build-docs:
-	@$(MAKE) build-docs-website
+release-docs:
+	@echo "Rebuilding docs"
+	rm -rf site api
+	@echo "Updating website docs"
+	poetry run mike deploy --push --update-aliases ${VERSION} ${ALIAS}
+	@echo "Building API docs"
 	@$(MAKE) build-docs-api
 
-build-docs-api: dev
-	mkdir -p dist/api
-	poetry run pdoc --html --output-dir dist/api/ ./aws_lambda_powertools --force
-	mv -f dist/api/aws_lambda_powertools/* dist/api/
-	rm -rf dist/api/aws_lambda_powertools
-
-build-docs-website: dev
-	mkdir -p dist
-	poetry run mkdocs build
-	cp -R site/* dist/
+build-docs-api:
+	poetry run pdoc --html --output-dir ./api/ ./aws_lambda_powertools --force
+	mv -f ./api/aws_lambda_powertools/* ./api/
+	rm -rf ./api/aws_lambda_powertools
 
 docs-local:
 	poetry run mkdocs serve