init

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Notes CI
+
+on:
+  push:
+  pull_request:
+    branches: [master]
+
+jobs:
+
+  job:
+    name: Validate Notes
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Validate Notes
+        run: |
+          set -x
+          yq() {
+          docker run --rm -i -v "${PWD}":/workdir mikefarah/yq yq "$@"
+          }
+          yq v documents.yml # Validate documents.yml
+          for foo in $(yq r --printMode p documents.yml notes.*.*)
+          do
+            export SRC=$(yq r documents.yml $foo.path)
+            echo "Checking $SRC"
+            (cd "$SRC" && docker run --rm -v "$PWD:/data" ${{ secrets.DOCKER_REPO }}:latest) # Validate folder
+            echo "#################################"
+          done

.github/workflows/docker.yml

@@ -0,0 +1,24 @@
+name: Build Docker
+
+on:
+  push:
+    branches: [ master ]
+
+
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Login to DockerHub Registry
+        run: echo ${{ secrets.DOCKER_PASSWORD }} | docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin
+
+      - name: Build Docker
+        run: |
+          cd validator
+          docker build -t ${{ secrets.DOCKER_REPO }} .
+          docker push ${{ secrets.DOCKER_REPO }}

.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Upload Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+
+  job:
+    name: Upload Release Assets
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Zip source files
+        run: |
+          set -x
+          yq() {
+          docker run --rm -i -v "${PWD}":/workdir mikefarah/yq yq "$@"
+          }
+          mkdir -p zip
+          for foo in $(yq r --printMode p documents.yml notes.*.*)
+          do
+            export SRC=$(yq r documents.yml $foo.path)
+            export DEST="$PWD/zip/$(yq r documents.yml $foo.zip)"
+            (cd "$SRC" && zip -r "$DEST" .)
+          done
+
+      - name: Upload zips
+        run: | # from https://gist.github.com/superbrothers/af84a2f8af394a62352e06537a640746
+          set -x
+          assets=()
+          for asset in zip/*.zip; do
+            assets+=("-a" "$asset")
+          done
+          tag_name="${GITHUB_REF##*/}"
+          hub release create -d "${assets[@]}" -m "$tag_name" "$tag_name"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -0,0 +1,45 @@
+# dungeon-revealer Game System Notes
+
+A repository of notes ready to import into [dungeon-revealer](https://github.com/dungeon-revealer/dungeon-revealer/). The main purpose of this repository is to host system reference documents of role playing games.
+
+
+
+- [Dungeons and Dragons](notes/Dungeons%20and%20Dragons)
+  - [5e SRD][dnd-5e-srd]
+
+
+## Contributing
+
+Pull requests are welcome! We will only accept content released under permissive licenses such as OGL, CC, etc.
+
+1. Clone this repository: `git clone https://github.com/maxb2/game-system-notes.git`
+2. Add your document files in an appropriate folder. For example: `notes/game/document/`.
+  - Make sure the files you add have [appropriate headers](https://github.com/dungeon-revealer/dungeon-revealer/wiki/Notes#importing-notes) for dungeon-revealer.
+  - You must also include the license of your document.
+  - Do not add zip files. We have a workflow that generates the zip files.
+3. Add metadata for your document in [documents.yml](documents.yml) using the following template:
+```YAML
+  game:
+    document:
+      name: Document Title
+      path: path/to/folder
+      zip: game-document.zip
+```
+4. Add your document and links to the [README](README.md). For example:
+
+```Markdown
+- [Dungeons and Dragons](notes/Dungeons%20and%20Dragons)
+  - [5e SRD][dnd-5e-srd]
+
+[dnd-5e-srd]: https://github.com/maxb2/game-system-notes/releases/download/v0.1.0/dnd-5e-srd.zip
+```
+5. Submit a pull request.
+
+
+## TODO
+
+- [x] Lint documents in PRs.
+- [ ] Automatically generate the link tree in the README.
+- [ ] Add more [SRDs](https://www.dicegeeks.com/rpg-srds/).
+
+[dnd-5e-srd]: https://github.com/maxb2/game-system-notes/releases/download/v0.1.0/dnd-5e-srd.zip

documents.yml

@@ -0,0 +1,12 @@
+---
+notes:
+  # game:
+  #   document:
+  #     name: Nice Document Name
+  #     path: path/to/folder
+  #     zip: game-document.zip
+  dnd:
+    5e-srd:
+      name: 5e SRD
+      path: notes/Dungeons and Dragons/5e-SRD
+      zip: dnd-5e-srd.zip