Skip to content

Update generate_documentation.yml #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benrobson merged 1 commit into from
Sep 25, 2025
Merged

Update generate_documentation.yml #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 33 additions & 19 deletions .github/workflows/generate_documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,67 @@
# This workflow will generate the documentation for zander-docs dynamically

name: Generate documentation
name: Generate Documentation

on:
push:
branches: [master]
pull_request:
branches: [master]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18] # Easily add more versions if needed

steps:
- uses: actions/checkout@v2
- name: Checkout Repository
uses: actions/checkout@v3
with:
submodules: recursive

token: ${{ secrets.GITHUB_TOKEN }}

Comment on lines +19 to +23
Copy link

@coderabbitai coderabbitai bot Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Upgrade actions/checkout to v4 now.

actions/checkout@v3 still targets the deprecated Node 16 runtime, which GitHub stopped running in March 2025. This workflow will fail once executed on current runners. Bump to v4 (Node 20) to restore compatibility.

-      - name: Checkout Repository
-        uses: actions/checkout@v3
+      - name: Checkout Repository
+        uses: actions/checkout@v4
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
with:
submodules: recursive
token: ${{ secrets.GITHUB_TOKEN }}
- name: Checkout Repository
uses: actions/checkout@v4
with:
submodules: recursive
token: ${{ secrets.GITHUB_TOKEN }}
🧰 Tools
🪛 actionlint (1.7.7)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🤖 Prompt for AI Agents 
.github/workflows/generate_documentation.yml around lines 19-23: the workflow
uses actions/checkout@v3 which targets deprecated Node 16 and will fail on
current runners; update the action reference to actions/checkout@v4 to use the
Node 20 runtime, leaving the existing with: block (submodules: recursive and
token) unchanged, and run a quick workflow lint or dry-run to ensure
compatibility.

- name: Set up Python 3.10
uses: actions/setup-python@v2
uses: actions/setup-python@v4
with:
python-version: "3.10"

- name: Install dependencies
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
if [ -f requirements.txt ]; then
python -m pip install -r requirements.txt
else
echo "No requirements.txt found, skipping Python dependency install."
Comment on lines +25 to +35
Copy link

@coderabbitai coderabbitai bot Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Move actions/setup-python to v5 for Node 20 support.

Version 4 of actions/setup-python is also locked to Node 16 and no longer runs on GitHub-hosted runners. Upgrade to v5 to avoid immediate workflow failures.

-      - name: Set up Python 3.10
-        uses: actions/setup-python@v4
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
if [ -f requirements.txt ]; then
python -m pip install -r requirements.txt
else
echo "No requirements.txt found, skipping Python dependency install."
- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
if [ -f requirements.txt ]; then
python -m pip install -r requirements.txt
else
echo "No requirements.txt found, skipping Python dependency install."
🧰 Tools
🪛 actionlint (1.7.7)

25-25: the runner of "actions/setup-python@v4" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🤖 Prompt for AI Agents 
In .github/workflows/generate_documentation.yml around lines 25 to 35, the
workflow uses actions/setup-python@v4 which is locked to Node 16 and will fail
on current GitHub-hosted runners; update the step to use actions/setup-python@v5
(preserving the python-version: "3.10" and the subsequent dependency-install
logic) so the action runs on Node 20-compatible runners and the workflow no
longer fails.

fi
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
cache: "npm"
cache: npm
Comment on lines +39 to +42
Copy link

@coderabbitai coderabbitai bot Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Update actions/setup-node to v4 to keep the workflow runnable.

actions/setup-node@v3 is deprecated alongside Node 16 support. Switching to v4 (Node 20) is required for the step to execute successfully.

-      - name: Set up Node.js
-        uses: actions/setup-node@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
🧰 Tools
🪛 actionlint (1.7.7)

39-39: the runner of "actions/setup-node@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🤖 Prompt for AI Agents 
.github/workflows/generate_documentation.yml around lines 39 to 42: the workflow
uses actions/setup-node@v3 which is deprecated; update the action reference to
actions/setup-node@v4 and ensure the matrix.node-version entries are compatible
with v4 (e.g., Node 20) so the step runs successfully.


- name: Generate API documentation
run: |
cd vendor
python APIGenerator/src/gen.py --build
if [ -d vendor ]; then
cd vendor
python APIGenerator/src/gen.py --build
else
echo "⚠️ Vendor folder not found. Skipping API generation."
fi
- name: npm install and build
- name: Install and Build with npm
run: |
npm ci
if [ -f package-lock.json ]; then
npm ci
else
npm install
fi
npm run build --if-present
- name: Deploy 🚀
if: success() # only deploy if build succeeds
uses: JamesIves/github-pages-deploy-action@v4.2.3
with:
branch: gh-pages # The branch the action should deploy to.
folder: build # The folder the action should deploy.
branch: gh-pages
folder: build
Loading