Skip to content

frontend/scripts/check_frontend_release.sh — what does it do? #10

Description

@zhaojingyu2

I see this script referenced in the README's "Verification" section (line 339-341) but the file is currently a black box to a first-time reader of the repo: there is no description in README.md nor in docs/DEVELOPER_GUIDE.md of what it covers.

Two related observations:

  1. backend/scripts/check_backend_release.sh is at least transparent: I can see it runs py_compile and pytest -q and then imports app.main:app (check_backend_release.sh:8-15). That's a clear contract.

  2. The top-level scripts/check_release.sh just delegates to both (scripts/check_release.sh:6-7), so there's no single source of truth for "what does release readiness mean for FAROS".

Could the README's Verification section spell out, in one or two lines per script, exactly what passes and fails? Today a contributor running bash scripts/check_release.sh doesn't know if a failure means "you didn't npm install" or "you broke a release-blocking test".

Also: is the intent that check_frontend_release.sh covers npm run typecheck and npm run lint? If so, please document that, because they're the things most likely to break when a PR touches frontend/src/lib/api/contracts/mappers.ts (277 lines of DTO mapping).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions