forked from vmware-archive/gangway
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from numberly/pages
docs: add gh pages workflow
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Deploy docs | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
build: | ||
name: Deploy docs | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Download source | ||
uses: actions/checkout@v3 | ||
- name: Install Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: '3.x' | ||
- name: Install Python dependencies | ||
run: | | ||
python -m pip install --upgrade hatch | ||
- name: Build site | ||
run: hatch -e docs run mkdocs build | ||
- name: Deploy to gh-pages | ||
if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
uses: oprypin/push-to-gh-pages@v3 | ||
with: | ||
publish_dir: site | ||
commit_message: 'Generate docs: ' |