Skip to content

Commit

Permalink
Updated: Docs Workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Sewer56 committed Feb 21, 2024
1 parent ad2e03a commit 4f26cc1
Showing 1 changed file with 17 additions and 25 deletions.
42 changes: 17 additions & 25 deletions .github/workflows/deploy-mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,27 @@
name: Deploy Documentation
name: MkDocs Build and Deploy

# Controls when the action will run.
on:
# Triggers the workflow on push on the master branch
push:
branches: [ main, master, refactor-reloaded3-compliance ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
push:
branches: [ main, master ]
paths:
- "mkdocs.yml"
- "docs/**"
pull_request:
branches: [ main, master ]
paths:
- "mkdocs.yml"
- "docs/**"

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
permissions:
contents: read
pages: write
id-token: write
steps:

# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Checkout Branch
uses: actions/checkout@v2
with:
submodules: recursive

# Deploy MkDocs
- name: Deploy MkDocs
# You may pin to the exact commit or the version.
# uses: mhausenblas/mkdocs-deploy-gh-pages@66340182cb2a1a63f8a3783e3e2146b7d151a0bb
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
uses: Reloaded-Project/reloaded-project-configurations-rust/.github/actions/deploy-mkdocs-documentation@v1
with:
REQUIREMENTS: ./docs/requirements.txt

0 comments on commit 4f26cc1

Please sign in to comment.