Merge pull request #116 from yguel/yguel-doc-kernel-update-howto #35
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| # Controls when the workflow will run | |
| on: | |
| # Triggers the workflow on push or pull request events but only for the master branch | |
| push: | |
| branches: [ main ] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "build" | |
| build_documentation: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -qq | |
| sudo apt-get install -y -qq python3-sphinx doxygen graphviz plantuml | |
| cd ./ethercat_driver_ros2/ | |
| pip install -r requirements.txt | |
| - name: Build doxygen | |
| run: | | |
| cd ./ethercat_driver_ros2/doxygen/ | |
| doxygen | |
| cd ../.. | |
| - name: Build documentation | |
| run: | | |
| cd ./ethercat_driver_ros2/sphinx/ | |
| make html | |
| cd ../.. | |
| - name: Create commit | |
| run: | | |
| git clone https://github.com/ICube-Robotics/ethercat_driver_ros2.git --branch gh-pages --single-branch gh-pages | |
| mkdir -p gh-pages/docs/ | |
| mkdir -p gh-pages/api/ | |
| cp -r ./ethercat_driver_ros2/sphinx/_build/html/* gh-pages/ | |
| cp -r ./ethercat_driver_ros2/doxygen/_build/html/* gh-pages/api/ | |
| cd gh-pages | |
| git config --local user.email "action@github.com" | |
| git config --local user.name "GitHub Action" | |
| git add . | |
| git commit -m "Update documentation" -a || true | |
| - name: Push changes | |
| uses: ad-m/github-push-action@master | |
| with: | |
| branch: gh-pages | |
| directory: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} |