Mkdocs #106
Workflow file for this run
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
| # This is a basic workflow to help you get started with Actions | |
| name: Mkdocs | |
| # Controls when the action will run. | |
| on: | |
| # Triggers the workflow on push or pull request events but only for the develop branch | |
| push: | |
| branches: [main] | |
| tags: | |
| - '*' | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| jobs: | |
| createdocu: | |
| if: startsWith(github.ref, 'refs/tags/') #runs only tagged version | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - name: Install Python packages | |
| run: pip install mkdocs-material mike | |
| - name: Update gh-pages | |
| run: | | |
| ls -alh | |
| find samples-*/ -name "*.md" | cpio -pd doc/ | |
| find samples-*/ -name "*.png" | cpio -pd doc/ | |
| find scripts/ -name "*.md" | cpio -pd doc/ | |
| find scripts/ -name "*.png" | cpio -pd doc/ | |
| if [ -f "scripts/doc/update_doc.sh" ]; then | |
| scripts/doc/update_doc.sh ${{ github.ref_name }} | |
| fi | |
| mike deploy --push --update-aliases ${{ github.ref_name }} latest |