Skip to content

Improvement: No longer download Doxygen for every build#2333

Merged
Davknapp merged 1 commit into
mainfrom
impr_doxygen_in_docker
May 28, 2026
Merged

Improvement: No longer download Doxygen for every build#2333
Davknapp merged 1 commit into
mainfrom
impr_doxygen_in_docker

Conversation

@spenke91
Copy link
Copy Markdown
Collaborator

@spenke91 spenke91 commented May 28, 2026

Closes #2331

Describe your changes here:

With the PR DLR-AMR/t8code-docker-images#5, Doxygen is downloaded and "installed" in the Dockerfile already, so we no longer have to do so for every build.

UPDATE: Seems to work...

image

All these boxes must be checked by the AUTHOR before requesting review:

  • The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • If the PR is related to an issue, make sure to link it.
  • The author made sure that, as a reviewer, he/she would check all boxes below.

All these boxes must be checked by the REVIEWERS before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually.
  • The code follows the t8code coding guidelines.
  • New source/header files are properly added to the CMake files.
  • The code is well documented. In particular, all function declarations, structs/classes and their members have a proper doxygen documentation. Make sure to add a file documentation for each file!
  • README.md files are updated if necessary.
  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue).

Tests

  • The code is covered in an existing or new test case using Google Test.
  • The code coverage of the project (reported in the CI) should not decrease. If coverage is decreased, make sure that this is reasonable and acceptable.
  • Valgrind doesn't find any bugs in the new code. This script can be used to check for errors; see also this wiki article.

If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

  • Should this use case be added to the github action?
  • If not, does the specific use case compile and all tests pass (check manually).

Scripts and Wiki

  • If a new directory with source files is added, it must be covered by the scripts/internal/find_all_source_files.sh to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example or tutorial and a Wiki article.

License

  • The author added a BSD statement to doc/ (or already has one).

@codecov
Copy link
Copy Markdown

codecov Bot commented May 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.57%. Comparing base (5c1e9cb) to head (74e31b4).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2333   +/-   ##
=======================================
  Coverage   82.57%   82.57%           
=======================================
  Files         116      116           
  Lines       18553    18553           
=======================================
  Hits        15320    15320           
  Misses       3233     3233           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Davknapp Davknapp added this pull request to the merge queue May 28, 2026
Merged via the queue into main with commit 4a82a3b May 28, 2026
40 checks passed
@Davknapp Davknapp deleted the impr_doxygen_in_docker branch May 28, 2026 08:09
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.

Improvement: Move wget of Doxygen version to Docker image rather than Github workflow

2 participants