forked from cloned-doy/whatsfly
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
58 additions
and
46 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 |
---|---|---|
@@ -1,54 +1,36 @@ | ||
# Simple workflow for deploying static content to GitHub Pages | ||
name: Deploy docs to Pages | ||
name: Deploy Docs | ||
|
||
on: | ||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ["main"] | ||
|
||
# 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
branches: | ||
- main | ||
|
||
jobs: | ||
# Single deploy job since we're just deploying | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
build-deploy: | ||
name: Build and deploy docs | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Setup Pages | ||
uses: actions/configure-pages@v5 | ||
- uses: actions/setup-python@v5 | ||
with: | ||
python-version: '3.12' | ||
- name: Install dependencies | ||
run: | | ||
pip install -r requirements.txt | ||
ln -s /home/runner/work/whatsfly/whatsfly /opt/hostedtoolcache/Python/3.12.5/x64/lib/python3.12/site-packages | ||
- name: Build mkdocs | ||
run: | | ||
cd docs | ||
mkdocs build | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
- name: Checkout 🛎️ | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Python 3 ⚙️ 🐍 | ||
uses: actions/setup-python@v2 | ||
|
||
- name: Cache dependencies 💾 | ||
uses: actions/cache@v2 | ||
with: | ||
# Upload entire repository | ||
path: 'docs/site/' | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 | ||
path: ~/.cache/pip | ||
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }} | ||
restore-keys: | | ||
${{ runner.os }}-pip- | ||
${{ runner.os }}- | ||
- name: Install dependencies 🔧 | ||
working-directory: docs | ||
run: make install | ||
|
||
- name: Build and deploy to GitHub Pages 🏗️ 🚀 | ||
working-directory: docs | ||
run: make deploy |
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 @@ | ||
.PHONY: docs | ||
|
||
default: install | ||
|
||
all: install build | ||
|
||
|
||
h help: | ||
@grep '^[a-z]' Makefile | ||
|
||
|
||
install: | ||
pip install pip --upgrade | ||
pip install -r requirements.txt | ||
|
||
upgrade: | ||
pip install pip --upgrade | ||
pip install -r requirements.txt --upgrade | ||
|
||
|
||
s serve: | ||
mkdocs serve --strict | ||
|
||
|
||
b build: | ||
mkdocs build --strict | ||
|
||
d deploy: | ||
mkdocs gh-deploy --strict --force |
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 @@ | ||
../requirements.txt |