search

GDC-WM / 2DGame2021

Has a very nice backend structure but no real gameplay (yet?)
MIT License
1 stars 1 forks source link

CI/CD: Doxygen documentation generation #38

Open BlastWind opened 3 years ago

BlastWind commented 3 years ago

CI/CD: Continuous integration, continuous deployment.

In /docs, each person uses doxygen to build a bunch of HTML files. What if, we build a server (we have a website where anyone can go to) that builds and displays the HTML files? Then, folks don't have to install doxygen and build locally themselves and they just go to that website.

Furthermore, we can demand the server to rebuild the diagrams everytime a commit to main is detected.

This is advanced CI/CD stuff, proceed if you want to really learn about build systems and how to open source code!

BlastWind commented 3 years ago

Things to look into
1) Github actions 2) Are there deployment (giving a server computer HTML files that the server computer hosts and displays) options from Github? If not, look into netlify, it has nice CI/CD set up with Github

Some potential helpers: https://github.com/GDC-WM/2DGame2021/actions/new https://stackoverflow.com/questions/61142433/automatic-c-documentation-generation-on-gitlab-project-using-doxygen