Skip to content
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

docs: fix error when installing PyYAML for gh pages #5462

Merged
merged 4 commits into from
Oct 28, 2023
Merged

docs: fix error when installing PyYAML for gh pages #5462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7ba665
chore: bump squidfunk/mkdocs-material from 8.3.9 to 9.3.6
DmitriyLewen Oct 27, 2023
de6af16
chore: bump PyYAML from 6.0 to 6.0.1
DmitriyLewen Oct 27, 2023
9684f83
chore(deps): install setuptools before install deps from requirements…
DmitriyLewen Oct 27, 2023
b0f195b
chore(deps): upgrade setuptools and wheel before install deps from re…
DmitriyLewen Oct 27, 2023
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
1 change: 1 addition & 0 deletions .github/workflows/mkdocs-dev.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ jobs:
python-version: 3.x
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools wheel
Copy link
Contributor Author

Choose a reason for hiding this comment

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

installing several dependencies required updating setuptools - https://github.com/aquasecurity/trivy/actions/runs/6663370495/job/18109128951
GitHub also recommends updating setuptools and wheel - https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#installing-dependencies

pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
pip install -r docs/build/requirements.txt
env:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/mkdocs-latest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ jobs:
python-version: 3.x
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools wheel
pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
pip install -r docs/build/requirements.txt
env:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
python-version: 3.x
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools wheel
pip install -r docs/build/requirements.txt
- name: Configure the git user
run: |
Expand Down
2 changes: 1 addition & 1 deletion docs/build/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM squidfunk/mkdocs-material:8.3.9
FROM squidfunk/mkdocs-material:9.4.6
Copy link
Contributor Author

Choose a reason for hiding this comment

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

squidfunk/mkdocs-material:9.4.6 (new version) also returns error for PyYAML 6.0.0.
Updated it to avoid conflicts with new PyYAML version other packages after subsequent Python updates.


## If you want to see exactly the same version as is published to GitHub pages
## use a private image for insiders, which requires authentication.
Expand Down
2 changes: 1 addition & 1 deletion docs/build/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Pygments==2.12.0
pymdown-extensions==9.5
pyparsing==3.0.8
python-dateutil==2.8.2
PyYAML==6.0
PyYAML==6.0.1
pyyaml-env-tag==0.1
six==1.16.0
termcolor==1.1.0
Expand Down