Skip to content

Tools structure - #904

Open
MakisH wants to merge 5 commits into
developfrom
tools-structure
Open

Tools structure#904
MakisH wants to merge 5 commits into
developfrom
tools-structure

Conversation

@MakisH

@MakisH MakisH commented Aug 15, 2026

Copy link
Copy Markdown
Member

Closes #703 by moving the development-oriented tools out of the tools/ directory, which is now only meant for runtime tools for users to copy.

While a better structure would rename these to, e.g., runtime-tools/ or similar, I don't want to introduce such a massively breaking change.

At the same time, this repository is mainly meant for users. For this reason, I moved the respective tools to .dev-tools, which would keep them hidden by default.

This PR also:

  • groups the tools together in releasing/ and linting/ (similarly to https://github.com/precice/precice/tree/develop/tools)
  • extends the releasing/README.md to include visualize-configs.sh
  • removes the executable flag from scripts that are only meant to be sourced (openfoam-remove-empty-dirs.sh and cleaning-tools.sh)
  • renames check.sh to check-filenames-permalinks.sh, to make it more specific.

In #900, tools/tests/ was already moved to tests/. That could even go to .tests/, to keep the list of directories strictly tutorials-related. That would at least help my file navigation a lot.

Any other ideas are welcome.

@MakisH MakisH self-assigned this Aug 15, 2026
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.

Mixed use of the tools/ directory

1 participant