-
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.
- Loading branch information
1 parent
143d42f
commit 6abb385
Showing
1 changed file
with
51 additions
and
57 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,57 +1,51 @@ | ||
--- | ||
name: Deploy Documentation | ||
on: | ||
push: | ||
branches: | ||
- main | ||
workflow_dispatch: | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
|
||
steps: | ||
# Step 1: Checkout the repository | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
|
||
# Step 2: Set up Python environment | ||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.11" | ||
cache: pip | ||
|
||
# Step 3: Cache MkDocs dependencies for faster builds | ||
- name: Cache MkDocs dependencies | ||
uses: actions/cache@v3 | ||
with: | ||
path: .cache | ||
key: ${{ runner.os }}-mkdocs-v1-${{ hashFiles('mkdocs.yml') }} | ||
restore-keys: | | ||
${{ runner.os }}-mkdocs-v1- | ||
# Step 4: Install required Python dependencies | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install \ | ||
mkdocs-material \ | ||
mkdocs-awesome-pages-plugin \ | ||
pymdown-extensions \ | ||
pygments | ||
# Step 5: Validate MkDocs configuration | ||
- name: Validate MkDocs configuration | ||
run: mkdocs build --config-file mkdocs.yml --strict | ||
|
||
# Step 6: Build and deploy documentation | ||
- name: Build and deploy documentation | ||
run: mkdocs gh-deploy --force | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
name: Deploy Documentation | ||
on: | ||
push: | ||
branches: | ||
- main | ||
workflow_dispatch: | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
|
||
steps: | ||
# Step 1: Checkout the repository | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
|
||
# Step 2: Set up Python environment | ||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.11" | ||
cache: pip | ||
|
||
# Step 3: Install required Python dependencies from requirements.txt | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install -r requirements.txt | ||
# Step 4: Cache MkDocs dependencies for faster builds | ||
- name: Cache MkDocs dependencies | ||
uses: actions/cache@v3 | ||
with: | ||
path: .cache | ||
key: ${{ runner.os }}-mkdocs-v1-${{ hashFiles('mkdocs.yml') }} | ||
restore-keys: | | ||
${{ runner.os }}-mkdocs-v1- | ||
# Step 5: Validate MkDocs configuration | ||
- name: Validate MkDocs configuration | ||
run: mkdocs build --config-file mkdocs.yml --strict | ||
|
||
# Step 6: Build and deploy documentation | ||
- name: Build and deploy documentation | ||
run: mkdocs gh-deploy --force | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |