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

#157: Added link checker for the documentation #158

Merged
merged 5 commits into from
Jan 31, 2024
Merged

#157: Added link checker for the documentation #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b919218
Added link checker for the documentation
tkilias Jan 31, 2024
b5b8647
Update changelog
tkilias Jan 31, 2024
c9df5c6
Fix yaml
tkilias Jan 31, 2024
33a7e27
Fix links in developer guide
tkilias Jan 31, 2024
b692174
Fix links in developer guide
tkilias Jan 31, 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
23 changes: 23 additions & 0 deletions .github/workflows/check_documentation_links.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Check Documentation Links

on:
push:
branches-ignore:
- "main"

jobs:
check_documentation_links:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Link Checker
id: lychee
uses: lycheeverse/[email protected]
with:
fail: true
args: --verbose --no-progress 'doc/**/*.md' 'README.md'

1 change: 1 addition & 0 deletions doc/changes/changes_0.1.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Version: 0.1.0
* #145: Added Docker Test Library to prepare Notebook tests
* #151: Setup SageMaker Credentials for notebook testing in the CI
* #155: Added a Notebook Link Checker to Github Actions
* #157: Added link checker for the documentation

## Bug Fixes

Expand Down
6 changes: 3 additions & 3 deletions doc/developer_guide/notebooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Please add or update the notebook files in folder [exasol/ds/sandbox/runtime/ans
## Notebook Testing

We are running tests for the notebooks in the Docker Edition of the AI Lab. For this we are creating a Docker test setup in
[test_notebooks_in_dss_docker_image.py](test/integration/test_notebooks_in_dss_docker_image.py) which installs test libraries into the AI Lab Docker Image.
It further creates a new test and Docker Container for each notebook test in [test/notebooks](test/notebooks).
[test_notebooks_in_dss_docker_image.py](../../test/notebook_test_runner/test_notebooks_in_dss_docker_image.py) which installs test libraries into the AI Lab Docker Image.
It further creates a new test and Docker Container for each notebook test in [test/notebooks](../../test/notebooks).
Notebook test names need to fit the pattern `nbtest_*.py`, to prevent pytest running them outside of Docker setup.

Environment variables with the prefix `NBTEST_` with which you call
[test_notebooks_in_dss_docker_image.py](test/integration/test_notebooks_in_dss_docker_image.py) are forwarded
[test_notebooks_in_dss_docker_image.py](../../test/notebook_test_runner/test_notebooks_in_dss_docker_image.py) are forwarded
into the Docker container and to the notebook test. You can use this to forward secrets to the notebook tests.

By default all created containers and images are removed after running the tests regardless of success or failure.
Expand Down
Loading