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

Have doxygen CI pipeline show all parser errors. #1687

Open
Dimi1010 opened this issue Jan 15, 2025 · 7 comments
Open

Have doxygen CI pipeline show all parser errors. #1687

Dimi1010 opened this issue Jan 15, 2025 · 7 comments

Comments

@Dimi1010
Copy link
Collaborator

Dimi1010 commented Jan 15, 2025

Can the doxygen pipeline be modified to show all parser errors per file instead of just 1 per file and aborting?
It is really annoying having to hunt down minor parser errors if there are multiple when a CI run only shows 1 per file.

@tigercosmos
Copy link
Collaborator

It seems that Doxygen stops processing when it encounters any error by default. One way to work around this is to make the error a warning: WARN_AS_ERROR = NO. However, I think running pre-commit locally first should be a better way.

@seladb
Copy link
Owner

seladb commented Jan 16, 2025

I'm not sure doxygen supports this option 😕
If it does, I agree we should use it...

@Dimi1010
Copy link
Collaborator Author

It seems that Doxygen stops processing when it encounters any error by default. One way to work around this is to make the error a warning: WARN_AS_ERROR = NO. However, I think running pre-commit locally first should be a better way.

pre-commit does not run the doxygen parser tho.

@Dimi1010
Copy link
Collaborator Author

Dimi1010 commented Jan 16, 2025

I'm not sure doxygen supports this option 😕
If it does, I agree we should use it...

@seladb I think the FAIL_ON_WARNINGS option for WARN_AS_ERROR described in the linked SO answer does that.

https://stackoverflow.com/a/66661052/11922936

@tigercosmos
Copy link
Collaborator

I think adding the Doxygen check in pre-commit is better, so we don't need to wait for the CI result.

@Dimi1010
Copy link
Collaborator Author

Dimi1010 commented Jan 16, 2025

Wasn't the doxigen config is pulled from the documentation repo tho? I don't think pre-commit can support that standalone?

Also the doxigen CI is currently the fastest CI even when it needs to process everything without a fast fail, so I don't think it will be a speed issue.

Generally it would be nice to add it to the precommit, but then the precommit CI also needs to run it in duplicate.

@tigercosmos
Copy link
Collaborator

I'm not sure how feasible it is, but it did annoy me before when I wanted to check if Doxygen was correct. I would wish we could have Doxygen in pre-commit. Also, if we make it, we can just delete the Doxygen CI.

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

No branches or pull requests

3 participants