mix-docs-gh-pages-action.yaml

gistfile1.txt

name: Generate mix docs & deploy to github pages
on:
  push:
    branches: 
      - main 
      
jobs:
  docs:
    name: Generate & deploy
    runs-on: ubuntu-latest
    container: elixir:1.13-alpine
    env:
      MIX_ENV: dev
      CI: true
    steps:
      - name: Trust my repo # see https://github.com/actions/checkout/issues/760
        run: export GIT_CEILING_DIRECTORIES=/__w && git config --global --add safe.directory /__w/my-app-name/my-app-name
      - name: Install hex
        run: mix local.hex --force
      - name: Install rebar
        run: mix local.rebar --force
      - name: Install dependencies
        run: mix deps.get
      - 
        name: Generate docs
        run: mix docs
      - 
        name: Deploy docs
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./doc
          cname: docs.mydomain.org # optional