Merge pull request #457 from SuffolkLITLab/add_beginners_guide_pages #194
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
| # Based on https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions | |
| # At times doesn't fail, even when deployment is broken | |
| name: Deploy documentation to GitHub Pages | |
| on: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| jobs: | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.9' | |
| - run: pip install docspec_python==2.2.1 git+https://github.com/nonprofittechy/pydoc-markdown@escape-brackets | |
| - uses: actions/checkout@v3 | |
| with: | |
| path: docs | |
| - uses: actions/checkout@v3 | |
| with: | |
| repository: SuffolkLITLab/docassemble-AssemblyLine | |
| path: docassemble-AssemblyLine | |
| - uses: actions/checkout@v3 | |
| with: | |
| repository: SuffolkLITLab/FormFyxer | |
| path: FormFyxer | |
| - uses: actions/checkout@v3 | |
| with: | |
| repository: SuffolkLITLab/docassemble-ALToolbox | |
| path: docassemble-ALToolbox | |
| - uses: actions/checkout@v3 | |
| with: | |
| repository: SuffolkLITLab/docassemble-EFSPIntegration | |
| path: docassemble-EFSPIntegration | |
| - name: Go to Docs directory | |
| run: | | |
| cd docs | |
| pydoc-markdown | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20 | |
| cache: npm | |
| cache-dependency-path: docs/package-lock.json | |
| - name: Build website | |
| run: | | |
| cd docs | |
| npm ci | |
| npm run build | |
| # Popular action to deploy to GitHub Pages: | |
| # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # Build output to publish to the `gh-pages` branch: | |
| publish_dir: ./docs/build | |
| # Assign commit authorship to the official GH-Actions bot for deploys to `gh-pages` branch: | |
| # https://github.com/actions/checkout/issues/13#issuecomment-724415212 | |
| # The GH actions bot is used by default if you didn't specify the two fields. | |
| # You can swap them out with your own user credentials. | |
| user_name: github-actions[bot] | |
| user_email: 41898282+github-actions[bot]@users.noreply.github.com |