chore: adjust generator for the docs site #639

mdelapenya · 2022-11-24T15:40:21Z

What does this PR do?

This PR is doing a few things to modify how the docs site is generated:

it uses the current latest version of Testcontainer for Go, taken from the mkdocs.yml file (see extra.latest_version field)
updates the instructions on how to run the generator, as it included an old version
fixes the generator to make sure the index.md file is the first element in the examples nav bar. The rest of examples will be alphabetically sorted
makes a restriction on examples name: only alphabetical chars are allowed

Improve the experience of generating examples for the latest release

Run the tests :)

examples/main.go

* main: Add toxiproxy example (testcontainers#643) Add spanner example (testcontainers#642) chore: sync governance files (testcontainers#641) Add pubsub example (testcontainers#640) chore: adjust generator for the docs site (testcontainers#639) Add datastore example (testcontainers#638) Add firestore example (testcontainers#637) fix: avoid panics when checking container state and container.raw is nil (testcontainers#635) feat: provide a tool to generate examples from code (#618) chore: bump version in mkdocs (#630) docs: remove code snippets from main README (testcontainers#631) docs: document replace directive for Docker Compose (testcontainers#632)

mdelapenya added 6 commits November 24, 2022 16:13

fix: use current release version in generated code

87e2c32

docs: fix go run command to include all Go files

53b388f

chore: simplify generation arguments

be366ae

fix: make tests more resilient

8def7f8

fix: make sure the index is the first item in the examples nav bar

95d8b71

chore: allow alphabetical chars only as example name

fda1800

mdelapenya requested a review from a team as a code owner November 24, 2022 15:40

mdelapenya added the chore Changes that do not impact the existing functionality label Nov 24, 2022

mdelapenya self-assigned this Nov 24, 2022

mdelapenya requested a review from a team November 24, 2022 15:40

fix: use correct regexp

56a8dc0

mdelapenya commented Nov 24, 2022

View reviewed changes

examples/main.go Outdated Show resolved Hide resolved

fix: typo

99c390c

eddumelendez approved these changes Nov 24, 2022

View reviewed changes

mdelapenya merged commit 57e54b3 into testcontainers:main Nov 24, 2022

mdelapenya deleted the fix-latest-version-in-template branch November 25, 2022 12:52