Quellcode durchsuchen

add workflow to generate API documents and update gh-pages

jiro4989 vor 5 Jahren
Ursprung
Commit
c6b372f994
2 geänderte Dateien mit 69 neuen und 0 gelöschten Zeilen
  1. 63 0
      .github/workflows/gh-pages.yml
  2. 6 0
      .github/workflows/test.yml

+ 63 - 0
.github/workflows/gh-pages.yml

@@ -0,0 +1,63 @@
+name: gh-pages
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  skip:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "Skip job"
+
+  before:
+    runs-on: ubuntu-latest
+    if: "! contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - run: echo "not contains '[skip ci]'"
+
+  docs:
+    runs-on: ubuntu-latest
+    needs: before
+    env:
+      nim_version: '1.2.0'
+    steps:
+      - uses: actions/checkout@v1
+      - name: Cache choosenim
+        id: cache-choosenim
+        uses: actions/cache@v1
+        with:
+          path: ~/.choosenim
+          key: ${{ runner.os }}-choosenim-${{ env.nim_version }}
+      - name: Cache nimble
+        id: cache-nimble
+        uses: actions/cache@v1
+        with:
+          path: ~/.nimble
+          key: ${{ runner.os }}-nimble-${{ hashFiles('*.nimble') }}
+      - uses: jiro4989/setup-nim-action@v1.0.2
+        with:
+          nim-version: ${{ env.nim_version }}
+
+      - name: Fix apt packages
+        run: |
+          # see. https://github.com/actions/virtual-environments/issues/675
+          sudo sed -i 's/azure\.//' /etc/apt/sources.list
+          sudo apt update -yqq
+
+      - name: Install freeglut
+        run: sudo apt install -y freeglut3 freeglut3-dev
+
+      - name: Install sdl2
+        run: sudo apt install --fix-missing -y libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev
+
+      - name: Generate API documents
+        run: nimble doc --index:on --project --out:docs --hints:off src/nodesnim.nim
+
+      - name: Deploy documents
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+        if: github.ref == 'refs/heads/master'
+

+ 6 - 0
.github/workflows/test.yml

@@ -48,6 +48,12 @@ jobs:
         with:
           nim-version: ${{ matrix.nim_version }}
 
+      - name: Fix apt packages
+        run: |
+          # see. https://github.com/actions/virtual-environments/issues/675
+          sudo sed -i 's/azure\.//' /etc/apt/sources.list
+          sudo apt update -yqq
+
       - name: Install xvfb
         run: sudo apt install -y xvfb