Skip to content

docs: test harness for api reference code samples#12338

Merged
mendonk merged 26 commits into
release-1.9.0from
docs-python-and-ts-examples
Apr 3, 2026
Merged

docs: test harness for api reference code samples#12338
mendonk merged 26 commits into
release-1.9.0from
docs-python-and-ts-examples

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Mar 25, 2026

Preview build
This PR is large mostly because of samples being moved out of docs and referenced.

The main files to check are test-api-examples-local.sh and the Makefile.

  • Python, JS, and curl code samples in docs/api-reference are now individual executable files. The code samples are then referenced in documentation.
  • Each file is now tested by a test harness run locally with a Makefile. To run it: make api_examples_local. Can also specify which samples to test with suites=javascript, for example.
  • Follow-on - add this to CI as a non-blocking check.

@mendonk mendonk self-assigned this Mar 25, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 25, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 2101e33f-d544-4af1-92bc-428b2492de5e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-python-and-ts-examples

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Mar 25, 2026
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 25, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 25, 2026
Copy link
Copy Markdown
Member

@Cristhianzl Cristhianzl left a comment

Choose a reason for hiding this comment

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

lgtm

@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label Mar 26, 2026
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 30, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 2, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 2, 2026
@mendonk mendonk requested a review from aimurphy April 2, 2026 13:51
@github-actions

This comment has been minimized.

Copy link
Copy Markdown
Collaborator

@aimurphy aimurphy left a comment

Choose a reason for hiding this comment

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

Approved aside from the horizontal scrolling issue

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 3, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 3, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 3, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 3, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 3, 2026

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@mendonk mendonk added this pull request to the merge queue Apr 3, 2026
Merged via the queue into release-1.9.0 with commit 3ee4bd5 Apr 3, 2026
98 of 99 checks passed
@mendonk mendonk deleted the docs-python-and-ts-examples branch April 3, 2026 17:08
Adam-Aghili pushed a commit that referenced this pull request Apr 15, 2026
* curl-examples-and-tests

* move-curl-examples

* docs-add-existing-js-and-python-examples

* add-python-and-js-examples

* use-code-snippet-not-code-block

* remove-unused-ts-files

* add-gitignore-for-docs-pycache

* test-api-commands-with-langflow-env-var

* add-fixtures-and-makefile-tests-pass

* no-action

* [autofix.ci] apply automated fixes

* [autofix.ci] apply automated fixes

* block-ruff-check-for-docs-examples

* add-horizontal-scrolling-and-pin-copy-button

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants