ci: add workflow to check correct API reference generation#10843
Merged
ci: add workflow to check correct API reference generation#10843
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Collaborator
Pull Request Test Coverage Report for Build 23188105850Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
We'd like auto-generated PRs for API reference updates to be automatically approved.
Ideally, we'd like to avoid broken Docusaurus builds (in case of failure, the website won't be updated in any case).
Since checking Vercel deployment success from a PR seems very hard to do (I tried some time ago), I am bringing into Haystack a mechanism introduced some time ago in core integrations and experimental: try generating the API reference when it changes in the PR and do a lightweight check with
docusaurus-mdx-checker.(deepset-ai/haystack-core-integrations#2829; deepset-ai/haystack-experimental#437)
Proposed Changes:
docusaurus-mdx-checkeron itdocstrings_checksumscript to avoid building the API reference when docstring don't changeHow did you test it?
Temporarily triggered the workflow on this PR (by changing configs or docstrings): https://github.com/deepset-ai/haystack/actions/runs/23156953275/job/67274135243
Works correctly
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.