Merge pull request #126 from roboflow/ci/maestro-publish-docs-fix

fix: 🐞 update workflow steps for Mkdocs deployment and package installation
roboflow · Feb 4, 2025 · 4ed36d8 · 4ed36d8
2 parents 47f5e94 + 3db6818
commit 4ed36d8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/.github/workflows/publish-dev-docs.yml b/.github/workflows/publish-dev-docs.yml
@@ -34,6 +34,6 @@ jobs:
         run: |
           git config --global user.name "github-actions[bot]"
           git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-      - name: 🚀 Deploy MkDoc-Material with mike
+      - name: 🚀 Deploy Mkdocs-Material with mike
         run: |
           MKDOCS_GIT_COMMITTERS_APIKEY=${{ secrets.GITHUB_TOKEN }} mike deploy --push develop
diff --git a/.github/workflows/publish-release-docs.yml b/.github/workflows/publish-release-docs.yml
@@ -20,22 +20,22 @@ jobs:
         python-version: ["3.10"]
     steps:
       - name: 🛎️ Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           fetch-depth: 0
           ref: ${{ github.head_ref }}
 
       - name: 🐍 Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
         with:
           python-version: '3.10'
       - name: 📦 Install Packages
-        run: pip install "mkdocs-material" "mkdocstrings[python]" "mkdocs-material[imaging]" mike
+        run: pip install -e ".[docs]"
       - name: ⚙️ Configure git for github-actions 👷
         run: |
           git config --global user.name "github-actions[bot]"
           git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-      - name: 🚀 Deploy MkDoc-Material 📚
+      - name: 🚀 Deploy Mkdocs-Material 📚
         run: |
             latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`)
             MKDOCS_GIT_COMMITTERS_APIKEY=${{ secrets.GITHUB_TOKEN }} mike deploy --push --update-aliases $latest_tag latest