publish yardoc pages to gh-pages

.github/workflows/publish_yarndoc.yml

@@ -0,0 +1,38 @@
+name: Publish yarndoc
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby using Bundler
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+
+      - name: install gems
+        run: bundle install && gem install yard
+
+      - name: generate documentation
+        run: yardoc --output-dir /tmp/docs/
+
+      - name: save docs and publish
+        run: |
+          git clone https://${{ secrets.OSC_ROBOT_GH_PUB_REPO_TOKEN }}@github.com/osc/ood_core.git /tmp/core
+          git config --global user.name "${{ secrets.OSC_ROBOT_GH_USER }}"
+          git config --global user.email "${{ secrets.OSC_ROBOT_GH_USER_EMAIL }}"
+          cd /tmp/core
+          git checkout gh-pages
+          rm -rf docs/
+          mv /tmp/docs .
+          git add docs/
+          git commit -m 'new docs'
+          git push
+

.gitignore

@@ -50,4 +50,8 @@ Gemfile.lock
 .rvmrc
 
 # SSHFS temp files
-._*
+._*
+
+# docs are only held in the gh-pages branch
+/docs/*
+!/docs/.keep