search

langroodi / doxygenize

Minimalist GitHub Action to automatically publish Doxygen-generated code documentation to GitHub Pages
MIT License
16 stars 3 forks source link

Doxygen confiugration file cannot be found at: ./Doxyfile #7

Closed mab0189 closed 2 years ago

mab0189 commented 2 years ago

Hello, I am trying to set up a doxygenize action for one of my repositorys.

I followed the provided instructions and placed the Doxyfile at the root of my repository but the action keeps failing with: Doxygen confiugration file cannot be found at: ./Doxyfile

Since I am new to github actions i am unsure if i did something wrong or if this is a bug. I would greatly appreciate your help!

langroodi commented 2 years ago

Hi!

I checked your YAML. There is no checkout action before running the doxygenize. Usually, developers have checkout action to start their build, so doxygenize won't explicitly execute the checkout action (it is also mentioned in the guideline). Because of that your directory is empty and doxygenize cannot find anything.

You can take a look to this example how to properly add doxygenize to your pipeline: https://github.com/langroodi/tareaSD/blob/133be0dfdae4847d62daf429342a0f6afdf533c1/.github/workflows/main.yml#L26

Good luck ;)

mab0189 commented 2 years ago

@langroodi Thank you very much for your help! It was clearly my fault - must have overlooked this step somehow. Everything works great now. What i really like about doxygenize is that it also takes care about the deployment to the github-pages. By the way i spotted a tiny typo in the Readme GitHUb Pages home directory which contains index.html file.

langroodi commented 2 years ago

No problem, nice to see that your pipeline is now green ;) Thanks for mentioning the typo. I will fix it in v1.5 which I am going to release this weekend (I hope) after doing some tests.

mab0189 commented 2 years ago

Sounds great! I will keep following this project.