Skip to content

Commit

Permalink
Fix docs CI workflow
Browse files Browse the repository at this point in the history
link generation was breaking becuase of a link to docker-compose which
has now been removed. Also update the CI github action to use poetry to
install deps and potentially resolve build error
  • Loading branch information
mikeywaites committed Jul 11, 2023
1 parent e0ece67 commit 80309c1
Show file tree
Hide file tree
Showing 3 changed files with 225 additions and 19 deletions.
36 changes: 19 additions & 17 deletions .github/workflows/lint-docs.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
name: Verify documentation
on:
push:
branches: [ "main", "master" ]
branches: ["main", "master"]
pull_request:
branches: [ "main", "master" ]
branches: ["main", "master"]

jobs:
verify-docs:
name: Check Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[tests]
- name: Build docs with MkDocs
run: |
make docs
- name: Check Markdown links
uses: gaurav-nelson/github-action-markdown-link-check@v1
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install Poetry
run: curl -sSL https://install.python-poetry.org | python
- name: Install dependencies
run: |
poetry env use '3.10'
poetry install --extras=testing
- name: Build docs with MkDocs
run: |
make docs
- name: Check Markdown links
uses: gaurav-nelson/github-action-markdown-link-check@v1
2 changes: 1 addition & 1 deletion docs/testcontainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ WireMockContainer(verify_ssl_certs=False)

## Using WireMockContainer inside Docker (dind)

It's common that you might need to start Testcontainers from inside of another container. The example project in [Testcontainer Example](../example/docker-compose.yml) actually does this.
It's common that you might need to start Testcontainers from inside of another container. The example project in `example/docker-compose.yml` actually does this.

When running spawning testcontainer inside of another container you will need to set the `WIREMOCK_DIND` config variable to true. When this env var is set the host of the wiremock container
will explicitly be set to `host.docker.internal`.
Expand Down
206 changes: 205 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 80309c1

Please sign in to comment.