Update ReadMe.md #336
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: Check for Complete Documentation | |
| on: | |
| # Triggers the workflow on push or pull request events | |
| push: | |
| pull_request: | |
| # Trigger when a release is created | |
| release: | |
| types: | |
| - published | |
| # Also give a manual trigger | |
| workflow_dispatch: | |
| inputs: | |
| publish: | |
| description: 'Publish Documentation to GitHub Pages' | |
| required: false | |
| type: boolean | |
| default: false | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| REBUILD_CACHE_NUMBER: 2 | |
| PYTHON_DEPS_ARCHIVE_NUM: 2 | |
| DOXYGEN_VERSION: Release_1_9_6 | |
| TEX_VERSION: 2019 | |
| # ^^ 2019 is the latest TeX live available on apt-get and that's good enough | |
| GRAPHVIZ_VERSION: 2.43.0 | |
| jobs: | |
| check_menu_inclusion: | |
| runs-on: ubuntu-latest | |
| if: "!contains(github.event.head_commit.message, 'ci skip')" | |
| name: Check that all classes are documented in the menu-a-la-carte example | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.x' | |
| # Using anwer from here to get the exit code and pass the output: https://stackoverflow.com/questions/59191913/how-do-i-get-the-output-of-a-specific-step-in-github-actions | |
| - name: check for classes in the menu example | |
| id: check_component | |
| continue-on-error: true | |
| run: | | |
| cd $GITHUB_WORKSPACE/continuous_integration | |
| python check_component_inclusion.py 2>&1 | tee check_component.log | |
| result_code=${PIPESTATUS[0]} | |
| missing_menu_docs=$(cat check_component.log) | |
| missing_menu_docs="${missing_menu_docs//'%'/'%25'}" | |
| missing_menu_docs="${missing_menu_docs//$'\n'/'%0A'}" | |
| missing_menu_docs="${missing_menu_docs//$'\r'/'%0D'}" | |
| echo "missing_menu_docs=missing_menu_docs" >> $GITHUB_OUTPUT | |
| if [[ $result_code ]]; then | |
| echo "$(cat check_component.log)" >> $GITHUB_STEP_SUMMARY | |
| else | |
| echo "Valid library.json =)" >> $GITHUB_STEP_SUMMARY | |
| fi | |
| echo "Finished menu inclusion verification" | |
| exit $result_code | |
| - name: Create commit comment | |
| uses: peter-evans/commit-comment@v2 | |
| if: steps.check_component.outcome=='failure' | |
| with: | |
| body: | | |
| All sensor and variable subclasses must be included in the Menu a la Carte example | |
| ${{ steps.check_component.outputs.missing_menu_docs }} | |
| - name: Fail if cannot find all menu flags | |
| id: verification_failure | |
| if: steps.check_component.outcome=='failure' | |
| run: exit 1 | |
| doc_build: | |
| runs-on: ubuntu-latest | |
| if: "!contains(github.event.head_commit.message, 'ci skip')" | |
| name: Build documentation | |
| steps: | |
| # check out the ModularSensors repo | |
| - uses: actions/checkout@v3 | |
| with: | |
| path: code_docs/ModularSensors | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.x' | |
| - name: Restore Python Dependencies | |
| uses: actions/cache@v3 | |
| id: cache_python | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-python-${{ env.REBUILD_CACHE_NUMBER }}-${{ env.PYTHON_DEPS_ARCHIVE_NUM }} | |
| - name: Install Pygments and other m.css Python Requirements | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip3 install --upgrade --upgrade-strategy only-if-needed jinja2 Pygments beautifulsoup4 | |
| - name: Restore Doxygen, Graphviz, and TeX Live | |
| id: cache_doxygen | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| /usr/lib/x86_64-linux-gnu/texlive | |
| /usr/lib/x86_64-linux-gnu/graphviz | |
| doxygen-src | |
| key: ${{ runner.os }}-doxygen-${{ env.REBUILD_CACHE_NUMBER }}-${{ env.DOXYGEN_VERSION }}-${{ env.TEX_VERSION }}-${{ env.GRAPHVIZ_VERSION }} | |
| - name: Build and install doxygen and its dependencies | |
| if: steps.cache_doxygen.outputs.cache-hit != 'true' | |
| run: | | |
| cd ${{ github.workspace }}/code_docs/ModularSensors/ | |
| chmod +x continuous_integration/build-install-doxygen.sh | |
| sh continuous_integration/build-install-doxygen.sh | |
| # check out my fork of m.css, for processing Doxygen output | |
| - name: Checkout m.css | |
| uses: actions/checkout@v3 | |
| with: | |
| # Repository name with owner. For example, actions/checkout | |
| repository: SRGDamia1/m.css | |
| path: code_docs/m.css | |
| - name: Generate all the documentation | |
| continue-on-error: true | |
| run: | | |
| cd ${{ github.workspace }}/code_docs/ModularSensors/ | |
| chmod +x continuous_integration/generate-documentation.sh | |
| sh continuous_integration/generate-documentation.sh 2>&1 | tee doxygen_run_output.log | |
| result_code=${PIPESTATUS[0]} | |
| echo "doxygen_warnings=$(cat docs/output_doxygen.log)" >> $GITHUB_OUTPUT | |
| echo "mcss_warnings=$(cat docs/output_mcss.log)" >> $GITHUB_OUTPUT | |
| echo "## Doxygen completed with the following warnings:" >> $GITHUB_STEP_SUMMARY | |
| echo "$(cat docs/output_doxygen.log)" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "## mcss Doxygen post-processing completed with the following warnings:" >> $GITHUB_STEP_SUMMARY | |
| echo "$(cat docs/output_mcss.log)" >> $GITHUB_STEP_SUMMARY | |
| echo "Finished generating documentation" | |
| exit $result_code | |
| - name: Deploy to github pages | |
| if: "(github.event_name == 'release' && github.event.action == 'published') || (github.event_name == 'workflow_dispatch' && github.event.inputs.publish == 'true')" | |
| uses: peaceiris/[email protected] | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ${{ github.workspace }}/code_docs/ModularSensorsDoxygen/m.css |