Merge pull request #5759 from psafont/endcover #31
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
| name: Generate and upload docs | |
| on: | |
| push: | |
| branches: master | |
| jobs: | |
| ocaml: | |
| name: Docs | |
| runs-on: ubuntu-22.04 | |
| env: | |
| XAPI_VERSION: "v0.0.0-${{ github.sha }}" | |
| STORAGE_DOCDIR: .gh-pages-xapi-storage | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Pull configuration from xs-opam | |
| run: | | |
| curl --fail --silent https://raw.githubusercontent.com/xapi-project/xs-opam/master/tools/xs-opam-ci.env | cut -f2 -d " " > .env | |
| - name: Load environment file | |
| id: dotenv | |
| uses: falti/dotenv-action@v1 | |
| - name: Update Ubuntu repositories | |
| run: sudo apt-get update | |
| - name: Use ocaml | |
| uses: ocaml/setup-ocaml@v2 | |
| with: | |
| ocaml-compiler: ${{ steps.dotenv.outputs.ocaml_version_full }} | |
| opam-repositories: | | |
| xs-opam: ${{ steps.dotenv.outputs.repository }} | |
| - name: Install dependencies | |
| run: opam pin list --short | xargs opam install --deps-only -v | |
| - name: Generate xapi-storage docs | |
| run: | | |
| mkdir $STORAGE_DOCDIR | |
| opam exec -- dune exec ocaml/xapi-storage/generator/src/main.exe -- gen_markdown --path=$STORAGE_DOCDIR | |
| - name: Deploy xapi-storage docs | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| deploy_key: ${{ secrets.ACTIONS_STORAGE_DEPLOY_KEY }} | |
| publish_dir: ${{ env.STORAGE_DOCDIR }} | |
| user_name: 'Github action on xapi-project/xen-api' | |
| user_email: 'github-actions-xapi-project-xen-api[bot]@users.noreply.github.com' | |
| external_repository: xapi-project/xapi-storage | |
| publish_branch: slate | |
| destination_dir: source/includes/ | |
| allow_empty_commit: false | |
| enable_jekyll: true # do not create .nojekyll file |