-
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.
chore: Update .gitignore to include Python bytecode and cache files; …
…add CI-CD workflow for MkDocs documentation build and deploy
- Loading branch information
Showing
2 changed files
with
59 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,49 @@ | ||
name: CI-CD | ||
|
||
# run on any push to any directory and a pull to main or development | ||
on: | ||
push: | ||
branches: | ||
- '*' | ||
pull_request: | ||
branches: | ||
- main | ||
- development | ||
|
||
jobs: | ||
################################################################################################ | ||
# Docs: Build and deploy mkdocs documentation | ||
################################################################################################ | ||
Docs: | ||
runs-on: ubuntu-latest | ||
|
||
permissions: | ||
# Need to give the action permission to write to the repository to deploy the docs | ||
contents: write | ||
|
||
strategy: | ||
matrix: | ||
os: [ubuntu-latest] | ||
|
||
steps: | ||
- name: Check-out repository | ||
uses: actions/checkout@v4 | ||
|
||
- name: Configure Git Credentials | ||
run: | | ||
git config user.name github-actions[bot] | ||
git config user.email github-actions[bot]@users.noreply.github.com | ||
- name: Install Pixi | ||
uses: prefix-dev/[email protected] | ||
with: | ||
pixi-version: v0.23.0 | ||
cache: true | ||
locked: false | ||
|
||
- name: Build documentation | ||
run: pixi run build | ||
|
||
- name: Build and deploy documentation | ||
if: github.ref == 'refs/heads/main' && github.event_name == 'push' | ||
run: pixi run 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 |
---|---|---|
@@ -1,3 +1,13 @@ | ||
# pixi environments | ||
.pixi | ||
*.egg-info | ||
|
||
site | ||
|
||
.DS_Store | ||
*.pyc | ||
*.pyo | ||
|
||
__pycache__ | ||
|
||
**/__pycache__/* |