Improve service documentation #157
Workflow file for this run
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
| # Copyright (c) 2022-2024 Contributors to the Eclipse Foundation | |
| # | |
| # This program and the accompanying materials are made available under the | |
| # terms of the Apache License, Version 2.0 which is available at | |
| # https://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. | |
| # | |
| # SPDX-License-Identifier: Apache-2.0 | |
| name: CI workflow | |
| on: | |
| workflow_dispatch: | |
| push: | |
| pull_request: | |
| jobs: | |
| Build-documentation: | |
| runs-on: ubuntu-latest | |
| name: Building documentation | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Hugo | |
| uses: peaceiris/[email protected] | |
| with: | |
| hugo-version: "0.123.3" | |
| extended: true | |
| - name: Verify that devcontainer works | |
| run: | | |
| cd .devcontainer | |
| docker buildx build -f Dockerfile -t test:latest . | |
| - name: Build | |
| run: | | |
| export NODE_PATH=$NODE_PATH:`npm root -g` | |
| npm i -g postcss postcss-cli autoprefixer | |
| echo "Build documentation for GitHub Pages" | |
| hugo --baseURL /velocitas | |
| - name: Fixes | |
| run: | | |
| for f in public/docs/index.html public/docs/_print/index.html; do sed -i 's,/docs/contributing/contribution,/velocitas/docs/contributing/contribution,g' $f; done | |
| - name: Check | |
| continue-on-error: true | |
| run: | | |
| echo -e "\`\`\`" >> $GITHUB_STEP_SUMMARY | |
| docker run -v $(pwd)/public:/public -v $(pwd)/.htmltest.yml:/.htmltest.yml --rm wjdp/htmltest -s /public -c /.htmltest.yml >> $GITHUB_STEP_SUMMARY || true | |
| echo -e "\`\`\`" >> $GITHUB_STEP_SUMMARY | |
| - name: Publish to GH Pages | |
| # Note that gh_pages isnt published to https://eclipse-velocitas.github.io/velocitas-docs/ | |
| # or the alias https://eclipse.dev/velocitas/ | |
| # So this basically just check if there are errors :-) | |
| # Only publish to gh_pages if this was a push to master | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| uses: peaceiris/[email protected] | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./public | |
| publish_branch: gh_pages |