Skip to content

Commit

Permalink
Set custom domain for documentation site
Browse files Browse the repository at this point in the history
The 'documentation-deploy' flow overwrites everything in the 'gh-pages' branch
every time there is a push to the master branch - that is why files like CNAME
go missing. There is a setting on the action that generates the site that should
set a custom domain name, which has been set appropriately.

Upgraded the checkout action. Removed commented code and todo.
  • Loading branch information
istride committed Sep 26, 2024
1 parent 7ab0ada commit 20af5c9
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions .github/workflows/documentation-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@ on:
branches:
- master
workflow_dispatch:

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v3
uses: actions/checkout@v4
# Only pull lfs files for documentation folder
# https://github.com/git-lfs/git-lfs/issues/1351
- name: Checkout git lfs partial files
Expand All @@ -20,13 +19,9 @@ jobs:
# Github pages fails when expecting LFS, so remove hook
run: rm .git/hooks/pre-push
- name: Deploy docs
# TODO - check if working on latest or pin to version (rather than commit)
uses: mhausenblas/mkdocs-deploy-gh-pages@e55ecab6718b449a90ebd4313f1320f9327f1386
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# CUSTOM_DOMAIN: optionaldomain.com
CUSTOM_DOMAIN: open-app-builder.com
CONFIG_FILE: documentation/mkdocs.yml
# EXTRA_PACKAGES: build-base
# GITHUB_DOMAIN: github.myenterprise.com
REQUIREMENTS: documentation/requirements.txt

0 comments on commit 20af5c9

Please sign in to comment.