precice / precice/tutorials

Integrate updating/checking the config visualizations in the CI

Open
#519 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
142
Forks
167
Avg merge
20h 24m
Merged PRs (30d)
11

Description

In #514, I added config visualizations and a script that generates them. I had also added a script that checks if the DOT files were updated after running the visualization script again and which was triggered in the CI.

I had also added the update and check in the pre-commit hook, but since the precice-config-visualizer at that time required additional dependencies for the GUI, which was not possible to disable at that time, decided to not add this to the pre-commit in the end.

After getting an easy-to-install variant of the precice-config-visualizer, we can add this back into the pre-commit.

We I also disagreed with @fsimonis on how to implement the checks in the workflow. While I am also not happy having the automatically generated DOT files in the repository, and while we could generate them in the website CI, I would still like to keep the PNG files in the tutorials repository, because then the README files remain readable offline and on GitHub. The question would be if we can make them reproducible, so that we don't get false alerts to update them.

Commit that removed the checking and CI part: https://github.com/precice/tutorials/pull/514/commits/fd9a639849764ad76932613bf6ce5a88b11f3798

Commit that removed the pre-commit additions: https://github.com/precice/tutorials/pull/514/commits/1e0aea57438b208a13cbb5c94cc656017cfa3eef

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the visualization and checking scripts from #514, the CI workflow, and the pre-commit hook additions referenced in commits fd9a639 and 1e0aea5. Determine how to make generated DOT and PNG files reproducible, then restore checks in CI and pre-commit so changes are detected without false alerts.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.