Merge pull request #3915 from uselagoon/openshiftpattern-deprecation #728
This file contains hidden or 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: Publish docs via GitHub Pages | |
on: | |
push: | |
branches: | |
- main | |
- mkdocs | |
jobs: | |
build: | |
name: Deploy docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout main | |
uses: actions/checkout@v4 | |
- name: Create main.html with tracking pixel | |
env: | |
SCARF_TRACKING_PIXEL: ${{ secrets.SCARF_TRACKING_PIXEL }} | |
if: | | |
github.repository_owner == 'uselagoon' && | |
env.SCARF_TRACKING_PIXEL != null | |
run: | | |
yq eval '.theme.custom_dir = "docs/overrides"' -i ./mkdocs.yml | |
mkdir -p $GITHUB_WORKSPACE/docs/overrides | |
cat << 'EOF' > $GITHUB_WORKSPACE/docs/overrides/main.html | |
{% extends "base.html" %} | |
{% block content %} | |
{{ super() }} | |
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=${{ env.SCARF_TRACKING_PIXEL }}" /> | |
{% endblock %} | |
EOF | |
# - name: Deploy docs | |
# uses: mhausenblas/mkdocs-deploy-gh-pages@master | |
# # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme | |
# env: | |
# GITHUB_TOKEN: ${{ secrets.GH_ACTION_PAT }} | |
# CONFIG_FILE: ./mkdocs.yml | |
# REQUIREMENTS: docs/requirements.txt | |
- name: Build | |
uses: Tiryoh/actions-mkdocs@v0 | |
with: | |
mkdocs_version: 'latest' # option | |
#mkdocs_version: '1.1' # option | |
requirements: 'docs/requirements.txt' # option | |
configfile: './mkdocs.yml' # option | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./site |