build_and_deploy_gh_pages #321
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
| # | |
| # If not stated otherwise in this file or this component's LICENSE file the | |
| # following copyright and licenses apply: | |
| # | |
| # Copyright 2022 Sky UK | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| # | |
| name: build_and_deploy_gh_pages | |
| # Controls when the workflow will run | |
| on: | |
| # Wait for specified workflow to complete before running | |
| workflow_run: | |
| workflows: ["build_ut"] | |
| branches: ["master", "rdkcentral:master"] | |
| types: [completed] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| # Single deploy job since we're just deploying | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt install doxygen graphviz | |
| - name: Generate doxygen documentation | |
| run: | | |
| mkdir -p build/gh_pages | |
| doxygen | |
| - name: Download Coverage Report | |
| uses: dawidd6/action-download-artifact@v3 | |
| with: | |
| workflow: build_ut.yml | |
| workflow_conclusion: success | |
| pr: ${{github.event.pull_request.number}} | |
| name: coverage_report | |
| path: build/gh_pages/coverage_report | |
| - name: Copy Main Page Index | |
| run: cp docs/index.html build/gh_pages | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'build/gh_pages' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |