Skip to content

chore(deps): bump huggingface/doc-builder/.github/workflows/build_pr_documentation.yml from 7ccf6c02dc2e3aea1b07f6668f783b20c3bf407c to 1b16dac5e33043af565fdf4c1b5b0fe81d0891c8 - #1104

Closed
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/github_actions/huggingface/doc-builder/dot-github/workflows/build_pr_documentation.yml-1b16dac5e33043af565fdf4c1b5b0fe81d0891c8
Closed

chore(deps): bump huggingface/doc-builder/.github/workflows/build_pr_documentation.yml from 7ccf6c02dc2e3aea1b07f6668f783b20c3bf407c to 1b16dac5e33043af565fdf4c1b5b0fe81d0891c8#1104
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/github_actions/huggingface/doc-builder/dot-github/workflows/build_pr_documentation.yml-1b16dac5e33043af565fdf4c1b5b0fe81d0891c8

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Sep 1, 2026

Copy link
Copy Markdown
Contributor

Bumps huggingface/doc-builder/.github/workflows/build_pr_documentation.yml from 7ccf6c02dc2e3aea1b07f6668f783b20c3bf407c to 1b16dac5e33043af565fdf4c1b5b0fe81d0891c8.

Changelog

Sourced from huggingface/doc-builder/.github/workflows/build_pr_documentation.yml's changelog.

Release checklist

  1. Checkout the release branch (for a patch the current release branch, for a new minor version, create one):
    git checkout -b vXX.xx-release
    The -b is only necessary for creation (so remove it when doing a patch).
  2. Change the version in src/doc_builder/__init__.py and pyproject.toml to the proper value.
  3. Commit these changes with the message: "Release: v<VERSION>".
  4. Add a tag in git to mark the release:
    git tag v<VERSION> -m 'Adds tag v<VERSION> for pypi'
    Push the tag and release commit to git:
    git push --tags origin vXX.xx-release
  5. Build the source distribution and the wheel in the top-level directory:
    rm -rf dist
    uv build
  6. Upload the package to the pypi test server first:
    twine upload dist/* -r testpypi
  7. Check that you can install it in a virtualenv by running:
    pip install hf-doc-builder
    pip uninstall hf-doc-builder
    pip install -i https://test.pypi.org/simple/ hf-doc-builder
    It's recommended to check that there are no issues building the docs, so try running a command like doc-builder.
  8. Upload the final version to actual pypi:
    twine upload dist/* -r pypi
  9. Add release notes to the tag in github once everything is looking hunky-dory.
  10. Go back to the main branch and update the version in src/doc_builder/__init__.py and pyproject.toml to the new version ".dev" and push to main.
Commits
  • 1b16dac Remove setup.py in favor of pyproject.toml (#816)
  • bcd143e Check anchors in links (#820)
  • 68667a5 fix(kit): accept a lowercase region in language codes (pt-br) (#823)
  • 0ab9ea0 Ship a pre-commit hook for doc-builder style (#818)
  • 4a56e30 Escape HTML and strip ANSI codes in notebook-to-mdx text outputs (#819)
  • da05e70 delete-old-prs: use a trusted publisher instead of the HF_ACCESS_TOKEN secret...
  • 0c19df9 Fix delete-old-prs.ts: correct bucket tree endpoint, fail loudly (#821)
  • af49b8d Declare ruff as a runtime dependency (#815)
  • ffa5997 Add ruff to the list of dependencies (#785)
  • 6dd1bda Preserve Markdown callout blockquote lines in docbuilder style docstring fo...
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Note

Low Risk
Single CI workflow pin change for PR doc previews; no application or auth logic affected.

Overview
Updates the reusable workflow reference in build_pr_documentation.yml from doc-builder commit 7ccf6c0 to 1b16dac, so PR documentation builds run against the newer upstream build_pr_documentation workflow.

Inputs are unchanged (commit_sha, pr_number, package: openenv, version_tag_suffix). Only the pinned SHA for huggingface/doc-builder/.github/workflows/build_pr_documentation.yml moves forward (Dependabot bump).

Reviewed by Cursor Bugbot for commit 72e176d. Bugbot is set up for automated code reviews on this repo. Configure here.

…documentation.yml

Bumps [huggingface/doc-builder/.github/workflows/build_pr_documentation.yml](https://github.com/huggingface/doc-builder) from 7ccf6c02dc2e3aea1b07f6668f783b20c3bf407c to 1b16dac5e33043af565fdf4c1b5b0fe81d0891c8.
- [Release notes](https://github.com/huggingface/doc-builder/releases)
- [Changelog](https://github.com/huggingface/doc-builder/blob/main/RELEASE.md)
- [Commits](huggingface/doc-builder@7ccf6c0...1b16dac)

---
updated-dependencies:
- dependency-name: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml
  dependency-version: 1b16dac5e33043af565fdf4c1b5b0fe81d0891c8
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@bot-ci-comment

bot-ci-comment Bot commented Sep 1, 2026

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Alignment Review Report

Dependabot github-actions bump of the huggingface/doc-builder build_pr reusable-workflow pin in .github/workflows/build_pr_documentation.yml:13: 7ccf6c021b16dac5 (# main). Single-line, YAML-only diff.

Automated Checks

  • Lint: PASS (N/A for scope) — 0 Python files changed. lint.sh is Python-only (src/, tests/, envs/); TOML/YAML aren't linted. (uv isn't installed on the review VM, so the hook no-ops without touching the tree.)
  • Debug code: CLEANcheck-debug.sh scans src/ only; every hit is pre-existing (console.print CLI output + serve/__main__ TODOs), none in this diff.
  • YAML validity: build_pr_documentation.yml parses cleanly.

Doc-builder bump verification

  • Clean fast-forward: 7ccf6c02...1b16dac5 = ahead 12 / behind 0 (status: ahead); 1b16dac5...main == identical ⇒ the new SHA is doc-builder's current main HEAD, so the trailing # main comment stays accurate. New tip = doc-builder #816 "Remove setup.py in favor of pyproject.toml".
  • Caller contract (the thing that could break) — SAFE: build_pr_documentation.yml is the only OpenEnv-called workflow whose own definition changed across the delta, and the sole change is doc-builder #808 — an optional python_version input (type: string, no required, no default) plus uv venvuv venv ${{ inputs.python_version && format('--python {0}', inputs.python_version) || '' }} (byte-identical when unset). Required workflow_call inputs at 1b16dac5 are still exactly commit_sha / pr_number / package, all supplied by the caller (lines 14-18). OpenEnv doesn't pass python_version ⇒ keeps the runner's system Python, identical behavior. No new required input ⇒ won't fail to start.
  • Security: full 40-char SHA pin retained; build_pr passes no secrets ⇒ no credential surface. The other 11 commits touch doc-builder internals or workflows OpenEnv doesn't call (e.g. delete_old_pr_documentations.yml, check_links.py, notebook_to_mdx.py).
  • Artifact contract: build_pr's upload-artifact step is untouched ⇒ the doc-build-artifact handoff to upload_pr_documentation.yml is unchanged.
  • Mergeability: git merge-tree origin/main <head> is clean (no conflict); origin/main (38b2a313) == PR base ⇒ clean 1-commit fast-forward.

Open RFCs Context

rfcs/ = 000, 001, 002, 003, 004, 005, 008 (now on main), 010 — all In Review except 010 (Draft). None govern CI / GitHub Actions / the docs-build pipeline / dependency management, so none are implicated by a workflow SHA bump. (RFC 008 Environment Auto-Validation governs src/openenv/validation/** + openenv validate, not CI.)

Tier 1: Fixes Required

None.

Tier 2: Alignment Discussion

Principle Conflicts: None identified. Full-SHA pinning + keeping the pin at main HEAD aligns with the reproducibility/security posture in PRINCIPLES.md.

RFC Conflicts: None identified.

Non-blocking note (sibling pins)

Dependabot tracks each reusable-workflow path separately, so a temporary SHA skew is expected/benign: after this merges, build_pr_documentation.yml:13 will be @1b16dac5 while build_documentation.yml:12 (build_main) and upload_pr_documentation.yml:11 (upload) remain @7ccf6c02. This PR supersedes the earlier unmerged build_pr bump #1090 (→ af49b8dc); their own bumps / a codex aggregate reconverge the three pins. FYI @burtenshaw (github-actions updater / dependabot.yml owner).

Summary

  • 0 mechanical issues to fix
  • 0 alignment points for human review
  • 0 RFC conflicts

Clean, zero-risk first-party (HF-owned) doc-builder reusable-workflow SHA bump.

Open in Web View Automation 

Sent by Cursor Automation: Pre-review

build:
if: github.event.pull_request.draft == false
uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@7ccf6c02dc2e3aea1b07f6668f783b20c3bf407c # main
uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@1b16dac5e33043af565fdf4c1b5b0fe81d0891c8 # main

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bump target 1b16dac5 is a clean fast-forward of 7ccf6c02 (ahead 12 / behind 0) and equals doc-builder's current main HEAD, so the # main marker stays accurate.

Caller contract is safe. Across this 12-commit delta, the only change to this reusable workflow is doc-builder #808, which adds an optional python_version input (no required, no default) and makes the uv venv step byte-identical when it's unset. Required workflow_call inputs are still commit_sha / pr_number / package — all passed below (lines 14-18); OpenEnv doesn't set python_version, so the PR doc build is unchanged. Full 40-char SHA pin retained, and no secrets are passed here.

@burtenshaw

Copy link
Copy Markdown
Collaborator

Closed in favor of the non-env Dependabot aggregate PR #1109.

@burtenshaw burtenshaw closed this Sep 1, 2026
@dependabot @github

dependabot Bot commented on behalf of github Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

OK, I won't notify you again about this release, but will get in touch when a new version is available. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@dependabot
dependabot Bot deleted the dependabot/github_actions/huggingface/doc-builder/dot-github/workflows/build_pr_documentation.yml-1b16dac5e33043af565fdf4c1b5b0fe81d0891c8 branch September 1, 2026 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Dependencies enhancement New feature or request github_actions Pull requests that update GitHub Actions code size: small Small pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant