Skip to content

Commit

Permalink
CI: update pip in build doc workflow
Browse files Browse the repository at this point in the history
Needed to ensure that dependabot updates are
possible. Otherwise, the bot may submit version
changes that won't be pip installable
  • Loading branch information
SMoraisAnsys committed Dec 4, 2023
1 parent 98770fb commit 5c55155
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions .github/workflows/build-documentation.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Documentation Build

on: [pull_request, workflow_dispatch]
on: [pull_request, workflow_dispatch]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down Expand Up @@ -29,15 +29,29 @@ jobs:
with:
python-version: 3.8

- name: Create Python venv
run: |
python -m venv .venv
.\.venv\Scripts\Activate.ps1
- name: "Update pip"
run: |
.\.venv\Scripts\Activate.ps1
python -m pip install -U pip
- name: Install pyedb with doc dependencies
run: |
.\.venv\Scripts\Activate.ps1
pip install .[doc]
- name: Verify that pyedb can be imported
run: python -c "import pyedb"
run: |
.\.venv\Scripts\Activate.ps1
python -c "import pyedb"
- name: Retrieve pyedb version
run: |
.\.venv\Scripts\Activate.ps1
echo "Pyedb version: $(python -c "from pyedb import __version__; print(); print(__version__)" | tail -1)"
- name: Install doc build requirements
Expand All @@ -48,6 +62,7 @@ jobs:
# NOTE: we have to add the examples file here since it won't be created as gallery is disabled on linux.
- name: Documentation Build
run: |
.\.venv\Scripts\Activate.ps1
make -C doc clean
mkdir doc/source/examples -p
echo $'Examples\n========' > doc/source/examples/index.rst
Expand All @@ -56,6 +71,7 @@ jobs:
# Verify that sphinx generates no warnings
- name: Check for warnings
run: |
.\.venv\Scripts\Activate.ps1
python doc/print_errors.py
- name: Upload Documentation
Expand Down

0 comments on commit 5c55155

Please sign in to comment.