Skip to content

Commit

Permalink
Added github workflow (#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
ketankartoza authored Nov 7, 2024
1 parent b66391f commit 132787d
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
35 changes: 35 additions & 0 deletions .github/workflows/BuildMKDocsAndPublishToGithubPages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: 📖 Build MKDocs And Publish To Github Pages.yml
on:
push:
branches:
- main
# Allow manually running in the actions tab
workflow_dispatch:

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Install dependencies
uses: BSFishy/pip-action@v1
with:
packages: |
mkdocs-material
qrcode
- name: Checkout main from github
uses: actions/checkout@v4
- name: Create Mkdocs Config 🚀
working-directory: ./docs
run: ./create-mkdocs-html-config.sh
- name: Deploy docs to github pages
# This is where we get the material theme from
uses: mhausenblas/mkdocs-deploy-gh-pages@master
# Wrong
#uses: timlinux/QGISAnimationWorkbench@main
env:
# Read this carefully:
# https://github.com/marketplace/actions/deploy-mkdocs#building-with-github_token
# The token is automatically generated by the GH Action
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CONFIG_FILE: docs/mkdocs.yml
24 changes: 24 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Publish docs via GitHub Pages
on:
push:
branches:
- main

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v4

- name: Create Mkdocs Config 🚀
working-directory: ./docs
run: ./create-mkdocs-html-config.sh

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CONFIG_FILE: /docs/mkdocs.yml
EXTRA_PACKAGES: build-base

0 comments on commit 132787d

Please sign in to comment.