auto update doc #9
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
| # Sample workflow for building and deploying a Jekyll site to GitHub Pages | |
| name: Deploy GitHub Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| tags: | |
| - 'v*' | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install sphinx sphinx-rtd-theme myst-parser | |
| curl -o Doc/markdown/get_started.md https://raw.githubusercontent.com/mvig-robotflow/rfuniverse/main/README.md | |
| curl -o Doc/markdown/advanced_usages.md https://raw.githubusercontent.com/mvig-robotflow/rfuniverse/main/DevDoc.md | |
| Doc/make.bat html | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| name: github-pages | |
| path: Doc/_build/html/ | |
| retention-days: 1 | |
| - name: Create tar.gz archive | |
| run: | | |
| cp -a docs _site_standalone | |
| tar -czvf site.tar.gz -C _site_standalone . | |
| - name: Upload file to bucket | |
| uses: koraykoska/s3-upload-github-action@master | |
| env: | |
| FILE: ./site.tar.gz | |
| S3_ENDPOINT: ${{ secrets.S3_ENDPOINT }} | |
| S3_BUCKET: ${{ secrets.S3_BUCKET }} | |
| S3_ACCESS_KEY_ID: ${{ secrets.S3_ACCESS_KEY_ID }} | |
| S3_SECRET_ACCESS_KEY: ${{ secrets.S3_SECRET_ACCESS_KEY }} | |
| S3_PREFIX: mvig-robotflow/pyrfuniverse/latest | |
| S3_ACL: private | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 | |
| - name: Invoke deployment hook | |
| uses: distributhor/workflow-webhook@v2 | |
| env: | |
| webhook_url: ${{ secrets.WEBHOOK_URL }} | |
| webhook_secret: ${{ secrets.WEBHOOK_SECRET }} | |
| webhook_auth: ${{ secrets.WEBHOOK_AUTH }} | |
| data: '{ "project": "mvig-robotflow/pyrfuniverse" }' |