Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ci update doxygen #1070

Merged
merged 5 commits into from
Oct 13, 2023
Merged

Ci update doxygen #1070

merged 5 commits into from
Oct 13, 2023

Conversation

dlyr
Copy link
Contributor

@dlyr dlyr commented Oct 12, 2023

This PR update doxygen version, it also adds a new github action to test doc creation.

It fixes doxygen missing TOC in markdown doc.

This workflow might be run manually on branches and create an artifact with the produced doc.

I'm not sure it will be ok to be run on PR branch, but is should be, and also can be modified when needed with

on:
  pull_request:
    branches:
      - release-candidate

see https://build5nines.com/configuring-manual-triggers-in-github-actions-with-workflow_dispatch/
https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow

@dlyr dlyr requested a review from nmellado October 13, 2023 07:46
@dlyr dlyr added documentation Related to documentation github Related to GitHub (actions, CI) bug-fix labels Oct 13, 2023
@dlyr dlyr marked this pull request as ready for review October 13, 2023 07:47
@dlyr dlyr mentioned this pull request Oct 13, 2023
7 tasks
@dlyr
Copy link
Contributor Author

dlyr commented Oct 13, 2023

As I suspected, the manual workflow is only available when merged on master. It might be callable on any branch to test doc of this branch, but not usefull to test new doxygen version.

@codecov
Copy link

codecov bot commented Oct 13, 2023

Codecov Report

Merging #1070 (51d92c4) into release-candidate (e89ba19) will not change coverage.
Report is 1 commits behind head on release-candidate.
The diff coverage is n/a.

❗ Current head 51d92c4 differs from pull request most recent head 2f8aa16. Consider uploading reports for the commit 2f8aa16 to get more accurate results

@@                Coverage Diff                 @@
##           release-candidate    #1070   +/-   ##
==================================================
  Coverage              45.65%   45.65%           
==================================================
  Files                    312      312           
  Lines                  23063    23063           
==================================================
  Hits                   10530    10530           
  Misses                 12533    12533           

@dlyr dlyr merged commit bf8e7f2 into STORM-IRIT:release-candidate Oct 13, 2023
15 checks passed
@dlyr dlyr deleted the ci-update-doxygen branch October 13, 2023 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug-fix documentation Related to documentation github Related to GitHub (actions, CI) Ready to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants