Commit Graph

4 Commits (5204-v2-download-button)

Author SHA1 Message Date
Jason Stirnaman 60256a2ac9 chore(ci): tests: replace latest-patch tag with environment variable. 2023-11-01 18:33:27 -05:00
Jason Stirnaman c4b97f9acf
5025 fix and test python examples (#5207)
* chore(v3): add test replacements

* fix(v3): get-started/query samples, make testable
2023-10-30 16:48:09 -05:00
Jason Stirnaman 35f3f09edb
Python test placeholders (#5161)
* chore(ci): Update vocab.

* chore(test): Set language-specific replacements for code sample tests

This is a bit of kludge to allow for language-specific replacement patterns
while keeping the code samples valid when a user replaces placeholder strings with their own and copies the sample.
This is necessary for executing (not for validating syntax) of the code samples.

- Workaround for identifying language-specific replacements for pytest-codeblocks test runs.
- Uses Python f-strings to identify Python-specific placeholders.
- To import os for your code sample and hide it from users, wrap it in a comment and use the `pytest-codeblocks:cont` comment tag. See d0ca7e22b8/README.md?plain=1#L117
2023-10-03 10:09:47 -05:00
Jason Stirnaman 237b01877b
chore(qol): Test python and shell code samples. WIP - use for local testing only, not ready for CI. (#5154)
- Adds a Docker image, scripts, and configuration that install and run pytest-codeblocks on Python and shell code samples in Markdown.
- Copied from https://github.com/jstirnaman/docs-codeblocks/
- TODO: The script copies files into a tmp directory configured as a bind mount for the Docker container. We might want to replace this with the experimental `watch` feature.
- TODO: Use a secret to configure the token. As is, values subbed from the dotenv file are exposed in your Docker container history.
2023-09-26 14:56:21 -05:00