Documentation.yml 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. name: Documentation
  2. on:
  3. push:
  4. branches:
  5. - development
  6. paths:
  7. - ".github/workflows/Documentation.yml"
  8. - "Code/**"
  9. workflow_run:
  10. # DISCLAIMER: This trigger will only work if this workflow is located on the default branch!
  11. workflows: ["Documentation Configuration Changed"]
  12. branches:
  13. - "gh-pages"
  14. types:
  15. - completed
  16. permissions:
  17. contents: write
  18. jobs:
  19. docsgen:
  20. name: Generate documentation and publish it to Github Pages
  21. runs-on: ubuntu-latest
  22. steps:
  23. - name: Checkout gh-pages branch
  24. uses: actions/checkout@v3
  25. with:
  26. ref: gh-pages
  27. - name: Checkout development branch
  28. uses: actions/checkout@v3
  29. with:
  30. repository: RobotecAI/o3de-ros2-gem
  31. ref: development
  32. path: o3de-ros2-gem
  33. - name: Setup doxygen and graphviz
  34. run: |
  35. sudo apt update
  36. sudo apt install -y doxygen wget
  37. sudo apt install graphviz
  38. - name: Generate documentation
  39. run: doxygen Doxyfile
  40. - name: Remove the unused development branch folder
  41. run: rm -r o3de-ros2-gem
  42. - name: Deploy to GitHub Pages
  43. uses: JamesIves/[email protected]
  44. with:
  45. folder: .