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

Jump to bottom

DEV - Miscellaneous enhancements to CI #1928

Merged
merged 8 commits into from
Jul 15, 2024
Merged

DEV - Miscellaneous enhancements to CI #1928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
75fffca
Update permissions - coverage action
trallard Jul 15, 2024
f4e3688
Move graphviz install to reusable action
trallard Jul 15, 2024
b23e985
:memo: Add note about needing to install Graphviz
trallard Jul 15, 2024
af08aa1
Change pandoc action (#1929)
drammock Jul 15, 2024
6dcd46c
Remove bad substitution
trallard Jul 15, 2024
f468b90
Replace graphvix install with third-party action
trallard Jul 15, 2024
c2ad3f4
Merge branch 'main' into trallard/ci-updates
trallard Jul 15, 2024
50edaf6
Fix bad }} close
trallard Jul 15, 2024
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
10 changes: 9 additions & 1 deletion .github/actions/set-dev-env/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ inputs:
pandoc:
description: Whether this should install pandoc or not
required: false
default: "False"
default: "false"
graphviz:
description: Whether this should install Graphviz or not
required: false
default: "false"
Comment on lines +13 to +16
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tried to change this to the GH actions boolean false and setting the type: boolean here but GH actions complained that this had to be a string 🤷🏽 not sure why so left it as a string for now


runs:
using: composite
Expand All @@ -30,3 +34,7 @@ runs:
with:
pandoc-version: "latest"
if: ${{ inputs.pandoc }} == true

- name: "Install Graphviz"
uses: ts-graphviz/setup-graphviz@v2
if: ${{ inputs.graphviz }} == true
19 changes: 6 additions & 13 deletions .github/workflows/CI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ jobs:
uses: ./.github/actions/set-dev-env
with:
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
pandoc: true
graphviz: true
- name: "Run accessibility tests with playwright 🎭"
# build PST, build docs, then run a11y-tests
run: python -Im tox run -e py312-docs,a11y-tests
Expand All @@ -129,19 +131,7 @@ jobs:
with:
python-version: ${{ matrix.python-version }}
pandoc: true
- name: "Install Graphviz on Windows 🗔"
if: runner.os == 'Windows'
run: choco install graphviz
- name: "Install Graphviz on macOS "
if: runner.os == 'macOS'
run: |
brew update
brew install graphviz
- name: "Install Graphviz on Linux 🐧"
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends graphviz
graphviz: true
- name: "Build docs and check for warnings 📖"
shell: bash
run: |
Expand Down Expand Up @@ -191,6 +181,9 @@ jobs:
name: "check coverage"
needs: run-pytest
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- name: "Checkout repository 🛎"
uses: actions/checkout@v4
Expand Down
4 changes: 3 additions & 1 deletion docs/community/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,10 @@ The caveat to using `tox` is that this will not install the required hooks to ru

## Build the documentation

Now that you have `tox` installed and cloned the repository, you should be able to build the documentation locally.
Now that you have `tox` installed and cloned the repository, you will need to install Graphviz to build the documentation.
To install Graphviz, follow the instructions in the [Graphviz documentation for your operating system](https://graphviz.org/download/).

Once you have `tox` and Graphviz installed, you can build the documentation.
To build the documentation with `tox`, run the following command:

```console
Expand Down
Loading