docs/.github/workflows/dev.yml at main · 0xPlaygrounds/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
name: Dev Docs

on:
  workflow_dispatch:
  push:
    branches: [ dev ]

env:
  POETRY_VERSION: "1.3.2"
  PYTHON_VERSION: "3.10"
  CHANGELOG_URL: "https://raw.githubusercontent.com/0xPlaygrounds/subgrounds/main/CHANGELOG.md"
  CONTRIBUTING_URL: "https://raw.githubusercontent.com/0xPlaygrounds/subgrounds/main/CONTRIBUTING.md"

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    # ---------------------------------------------
    # -----           gather repo             -----
    # ---------------------------------------------
    - uses: actions/checkout@v3

    # ---------------------------------------------
    # -----      setup and cache python       -----
    # ---------------------------------------------
    - uses: actions/setup-python@v4
      with:
        python-version: ${{ env.PYTHON_VERSION }}

    - name: Cache poetry
      id: cache-poetry
      uses: actions/cache@v3
      with:
        path: ~/.local
        key: poetry-${{ runner.os }}-${{ env.POETRY_VERSION }}

    - name: Install poetry
      if: steps.cache-poetry.outputs.cache-hit != 'true'
      uses: snok/install-poetry@v1
      with:
        version: ${{ env.POETRY_VERSION }}
        virtualenvs-in-project: true

    - name: Cache venv
      id: cache-venv
      uses: actions/cache@v3
      with:
        path: .venv
        key: venv-${{ runner.os }}-${{ env.PYTHON_VERSION }}-${{ env.POETRY_VERSION }}-${{ hashFiles('poetry.lock') }}
        restore-keys: |
          venv-${{ runner.os }}-${{ env.PYTHON_VERSION }}-${{ env.POETRY_VERSION }}-

    - name: Install dependencies
      if: steps.cache-venv.outputs.cache-hit != 'true'
      run: poetry install --no-root

    #----------------------------------------------
    #  -----       build & deploy docs       -----
    #----------------------------------------------
    - name: Grab subgrounds changelog and contributing
      run: |
        curl $CHANGELOG_URL > docs/subgrounds/changelog.md
        curl $CONTRIBUTING_URL > docs/subgrounds/contributing.md
        cp CONTRIBUTING.md docs/meta/contributing.md


    - name: Build and deploy documentation
      if: github.repository == '0xPlaygrounds/docs'
      run: |
        set -e
        git config --global user.name "github-actions"
        git config --global user.email "action@github.com"
        poetry run mudkip build

    - name: Deploy to surge.sh
      uses: dswistowski/surge-sh-action@v1
      with:
        domain: 'https://pga-docs-dev.surge.sh'
        project: 'docs/_build/dist'
        login: ${{ secrets.surge_login }}
        token: ${{ secrets.surge_token }}