Skip to content

create python module that just has all markdown files#6398

Merged
adhami3310 merged 4 commits intomainfrom
auto-release-docs-app
Apr 27, 2026
Merged

create python module that just has all markdown files#6398
adhami3310 merged 4 commits intomainfrom
auto-release-docs-app

Conversation

@adhami3310
Copy link
Copy Markdown
Member

No description provided.

@adhami3310 adhami3310 requested review from a team and Alek99 as code owners April 27, 2026 21:41
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 27, 2026

Merging this PR will not alter performance

✅ 9 untouched benchmarks


Comparing auto-release-docs-app (aa8107f) with main (c278404)

Open in CodSpeed
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 27, 2026

Greptile Summary

This PR introduces reflex-docs-bundle, a new internal Python wheel that bundles all markdown docs from the docs/ tree for redistribution, and refactors several GitHub Actions inline shell scripts into standalone .sh files. It also removes the googletrans/typesense dependencies from reflex-docs-app and replaces the translation demo in docs/vars/custom_vars.md with a simpler string-upper example.

Confidence Score: 5/5

Safe to merge — all findings are P2 and do not affect current behavior.

Only P2 findings: a latent rglob-on-file bug in the build hook (not triggered by current docs/ structure) and a missing path-traversal guard in an internal-only package. No regressions in the publish pipeline.

docs/package/scripts/hatch_build.py (latent rglob bug) and docs/package/reflex_docs_bundle/init.py (path traversal)

Important Files Changed

Filename Overview
docs/package/scripts/hatch_build.py New Hatchling build hook that bundles markdown from the parent docs/ tree; correctly skips app/ and package/ subdirectories and handles sdist rebuild, but calling rglob on a non-directory file path is a latent bug.
docs/package/reflex_docs_bundle/init.py New public API (DOCS_DIR, list_docs, get_doc) for the bundled docs package; missing path-traversal guard in get_doc.
.github/scripts/publish/parse_tag.sh Extracted from inline workflow YAML; correctly maps package tags to build directories under packages/; reflex-docs-bundle is not published to PyPI so the lack of a docs/ case is intentional.
docs/app/reflex_docs/pages/docs/init.py Adds _pkg_root exclusion so docs/package/ markdown files are not picked up by the docs app's discovery loop; straightforward and correct.
.github/scripts/auto_release_internal/detect.sh Inline script extraction; behavior unchanged — detects reflex-components-internal and reflex-site-shared only. reflex-docs-bundle is intentionally not published to PyPI.
docs/package/pyproject.toml New package manifest for reflex-docs-bundle; uses uv-dynamic-versioning with correct tag prefix and registers the custom hatch build hook.
docs/vars/custom_vars.md Example updated to remove googletrans dependency — replaces translation demo with a simple string-upper transformation; clean change.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[docs/ tree] -->|iterdir top-level| B{BundleDocsHook}
    B -->|skip: app/, package/, dotfiles| C[ignored]
    B -->|.md file at top level| D[include directly]
    B -->|directory| E[rglob *.md]
    D --> F[force_include into wheel]
    E --> F
    F --> G[reflex_docs_bundle/_docs/]
    G --> H[reflex_docs_bundle.__init__]
    H -->|DOCS_DIR| I[list_docs]
    H -->|get_doc rel_path| J[read_text]
Loading

Reviews (3): Last reviewed commit: "ignore both dirs" | Re-trigger Greptile

Comment thread .github/workflows/publish.yml
Comment thread .github/scripts/auto_release_internal/detect.sh Outdated
Comment thread docs/app/scripts/hatch_build.py Outdated
@adhami3310
Copy link
Copy Markdown
Member Author

@greptile

@adhami3310 adhami3310 changed the title auto release docs app Apr 27, 2026
@adhami3310
Copy link
Copy Markdown
Member Author

@greptile

@adhami3310 adhami3310 merged commit 7b5d77e into main Apr 27, 2026
69 checks passed
@adhami3310 adhami3310 deleted the auto-release-docs-app branch April 27, 2026 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants