Skip to content

fix(docs): publish the site again and stop promising files to BYO guardrails - #1975

Merged
apetraru-uipath merged 2 commits into
mainfrom
fix/docs-publish-and-byo-files
Nov 5, 2026
Merged

apetraru-uipath merged 2 commits into
mainfrom
fix/docs-publish-and-byo-files

Conversation

@apetraru-uipath

@apetraru-uipath apetraru-uipath commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

What changed?

Publish Docs has been failing since 2026-10-26 (9 runs, all red; the last success was a dispatch on 2026-10-25), so nothing merged since then is on uipath.github.io, including the coded-agent guardrail file support from #1940. The "Clone plugins" step aborts while cloning uipath-langchain-python:

Error downloading samples/hitl-inbox-server/uipath.db: batch response: Resource not accessible by personal access token
fatal: samples/hitl-inbox-server/uipath.db: smudge filter lfs failed

The REPO_ACCESS token cannot read Git LFS, and the docs build reads no LFS content.

  • .github/workflows/publish-docs.yml: the clone step sets GIT_LFS_SKIP_SMUDGE=1, so LFS files stay as pointers and no LFS download is attempted.
  • packages/uipath/docs/core/guardrails.md, Files section: the BYO sentence said a BYO connector reads attachments when it declares document support. The Agents backend evaluates BYO guardrails on the text only and never passes them the files, so it now says ByoValidator accepts detection_scope but BYO guardrails evaluate text only.

Merging this touches packages/uipath/docs/**, so it triggers Publish Docs itself. The matching langchain docs fix is UiPath/uipath-langchain-python#1195.

How has this been tested?

  • Reproduced the workflow locally: cloned the three plugin repos with GIT_LFS_SKIP_SMUDGE=1 (all exit 0, uipath.db left as an LFS pointer), created the same four symlinks, ran uv sync --all-extras and uv run mkdocs build. The site builds. The built core/guardrails page contains the "Files (attachments)" section and the new BYO sentence.
  • Not verifiable before merge: the token behaviour on the hosted runner. Skipping the smudge removes the only LFS call, so the failing request is no longer made.

No package version bump: no src/ changed (the version check only applies to source changes; docs-only precedent #1884).

🤖 Generated with Claude Code

Publish Docs has failed on every run since 2026-10-26. Cloning
uipath-langchain-python smudges the LFS object
samples/hitl-inbox-server/uipath.db, and the REPO_ACCESS token cannot
read LFS ("batch response: Resource not accessible by personal access
token"), so the checkout aborts. The docs build reads no LFS content,
so the clone step skips the smudge.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are reported for the documentation and publishing-workflow changes.

No open issues 🎉

What changed in this PR

This PR addresses the docs publishing failure and corrects the attachment-support guidance for BYO guardrails in the UiPath Python SDK documentation.

Changes:

  • Skips Git LFS downloads when cloning plugin repositories, avoiding the token-access failure blocking publication.
  • Clarifies that ByoValidator accepts detection_scope, but BYO guardrails evaluate text only and do not read files.
File Description
packages/​uipath/​docs/​core/​guardrails.md Corrects the documented BYO guardrail file-support limitation.
.github/​workflows/​publish-docs.yml Sets GIT_LFS_SKIP_SMUDGE=1 for plugin cloning.

Review effort: Balanced

The Files section said a BYO connector reads attachments when it
declares document support. The Agents backend evaluates BYO guardrails
on the text only and never passes them the files, so say that instead.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@apetraru-uipath
apetraru-uipath force-pushed the fix/docs-publish-and-byo-files branch from b6e5042 to 2d58925 Compare November 4, 2026 15:12
@sonarqubecloud

sonarqubecloud Bot commented Nov 4, 2026

Copy link
Copy Markdown

@apetraru-uipath
apetraru-uipath merged commit 5b2ea4c into main Nov 5, 2026
97 checks passed
@apetraru-uipath
apetraru-uipath deleted the fix/docs-publish-and-byo-files branch November 5, 2026 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants