Skip to content

move variables.json update to post-merge automatic commit action along with linting and formatting #4180

Open

Description

@oharboe

Description

Now we have another annoying failure mode, we have to run a conversion from variables.yaml to .json file or the PR will fail.

While we are at it, can we also run flow/scripts/generatedocs.py as a post-merge action?

Suggested Solution

fix it post merge automatically, no need for developers to do anything here.

Additional Context

No response

Activity

  1. github-actions commented on Jun 22, 2026

    @github-actions
    Contributor

    This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 21 days if no further activity occurs. Remove the Stale label or comment to keep it open.

  2. added
    StaleA stale PR or issue subject to automated closure.
    on Jun 22, 2026
  3. removed
    StaleA stale PR or issue subject to automated closure.
    on Jun 22, 2026
  4. sparsh-karna commented on Jun 23, 2026

    @sparsh-karna

    Hi @maliberty, @oharboe , can i work on this issue?

  5. github-actions commented on Aug 23, 2026

    @github-actions
    Contributor

    This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 21 days if no further activity occurs. Remove the Stale label or comment to keep it open.

  6. added
    StaleA stale PR or issue subject to automated closure.
    on Aug 23, 2026
  7. removed
    StaleA stale PR or issue subject to automated closure.
    on Aug 23, 2026
  8. github-actions commented on Oct 23, 2026

    @github-actions
    Contributor

    This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 21 days if no further activity occurs. Remove the Stale label or comment to keep it open.

  9. added
    StaleA stale PR or issue subject to automated closure.
    on Oct 23, 2026
  10. oharboe commented on Oct 23, 2026

    @oharboe
    CollaboratorAuthor

    @vvbandeira Ideally we could simply stop generating variables.json by requiring it in host Python and using PYTHON_EXE consistently. I could not find anything in the code that stated why this is not an option. #4721 shows that only Debian rodete doesn't install it in the install scripts for ORFS, I don't know if that's because it is impossible or because it isn't done or because a choice was made for reasons.

  11. oharboe commented on Oct 23, 2026

    @oharboe
    CollaboratorAuthor

    Proposal: after November 1, when ORFS is Bazel-only, shrink YAML handling to one tiny tool.

    variables.json has spread into git, CI, the setup scripts and the PyYAML install matrix. OpenROAD already depends on yaml-cpp for its 3DBlox readers (read_3dbv/read_3dbx), so a yaml2json built on it adds no new dependency and needs nothing from the host.

    PR 1, OpenROAD: add yaml2json, a small cc_binary on yaml-cpp, and include it in bazel run //:install, so it lands in <prefix>/bin next to openroad. OpenROAD already depends on yaml-cpp, so there's no additional dependency in OpenROAD.

    PR 2, ORFS (after PR 1 is bumped in):

    • Install it with OpenROAD: build_openroad.sh, etc/DockerHelper.sh and the Dockerfiles ship yaml2json wherever they ship openroad. variables.mk sets YAML2JSON the same way it sets OPENROAD_EXE, from PATH or from tools/install/OpenROAD/bin.
    • Wire it up: $(YAML2JSON) variables.yaml | $(PYTHON_EXE) <reader>.py. The readers are defaults.py (variables.mk), non_stage_variables.py (util.tcl), util/stage_art.py (flow.sh) and generate-variables-docs.py. Each reads stdin and fails on empty input.
    • Delete and stop thinking about:
      • flow/scripts/variables.json and its .gitattributes entry
      • flow/scripts/yaml_to_json.py
      • the "Check variables.json is up to date" CI step and the PyYAML venv it installs
      • pyyaml in etc/requirements-common.in and its lock file, and python3-yaml in DependencyInstaller.sh, along with the question of which platforms install it

    Both PRs are mechanical; an AI can carry them out.

  12. removed
    StaleA stale PR or issue subject to automated closure.
    on Oct 23, 2026
  13. maliberty commented on Oct 25, 2026

    @maliberty
    Member

    11/1 is when OR goes bazel only, not ORFS.

  14. oharboe commented on Oct 25, 2026

    @oharboe
    CollaboratorAuthor

    15. 11/1 is when OR goes bazel only, not ORFS.

    Thanks! Typo in suggestion. The option above still applies.

  15. reopened this on Nov 3, 2026
  16. oharboe commented on Nov 3, 2026

    @oharboe
    CollaboratorAuthor

    #4721 and the move to bazel only for OpenROAD paves the way to prune more dependencies, but we haven't done it yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions