DEV: publish GitHub Pages during release workflow (#363)

closes #363

Author: dwhieb

.github/CONTRIBUTING.md

@@ -34,7 +34,7 @@ The project would especially benefit from the following types of suggestions:
 
 The following scripts can be run from the command line:
 
-- `npm run build`: convert YAML > JSON, regenerate project documentation
+- `npm run build`: convert YAML > JSON
 - `npm run convert`: convert the YAML schemas to JSON
 - `npm run docs`: regenerate the project documentation
 - `npm test`: run tests

.github/PULL_REQUEST_TEMPLATE.md

@@ -32,3 +32,5 @@
 - [ ] **Run the tests** (`npm test`) and fix issues that arise. If you find an issue that is unrelated to the one you are working on, open a new issue for it.
 
 - [ ] **Update the project documentation** (`README.md`, `CONTRIBUTING.md`, etc.) to reflect the changes you made, if applicable.
+
+- [ ] **Build the project documentation** (`npm run docs`)

.github/README.md

@@ -1,4 +1,5 @@
 <!-- This readme is targeted at general users. The developer readme is located in the project root. -->
+
 # The Data Format for Digital Linguistics (Daffodil)
 
 ## Introduction
@@ -17,6 +18,7 @@ Please consider citing this specification in scholarly articles using this repos
 
 > Hieber, Daniel W. 2020. _Data Format for Digital Linguistics_. DOI:[10.5281/zenodo.1438589][Zenodo]
 
+[![GitHub stars](https://img.shields.io/github/stars/digitallinguistics/spec.svg?style=social&label=Stars)][GitHub]
 [![npm downloads](https://img.shields.io/npm/dt/@digitallinguistics/spec.svg)][npm]
 [![DOI](https://zenodo.org/badge/50221632.svg)][Zenodo]
 [![license](https://img.shields.io/github/license/digitallinguistics/spec.svg)][License]
@@ -196,7 +198,7 @@ This repository is maintained by [Daniel W. Hieber][Me] ([@dwhieb][19]).
 [Contributing]: https://github.com/digitallinguistics/spec/blob/master/.github/CONTRIBUTING.md
 [Developer]:    https://github.com/digitallinguistics/spec/blob/master/README.md
 [GitHub]:       https://github.com/digitallinguistics/spec
-[IGL]:           https://en.wikipedia.org/wiki/Interlinear_gloss
+[IGL]:          https://en.wikipedia.org/wiki/Interlinear_gloss
 [Issues]:       https://github.com/digitallinguistics/spec/issues
 [JSON]:         http://json.org/
 [License]:      https://github.com/digitallinguistics/spec/blob/master/.github/LICENSE.md

.github/workflows/release.yml

@@ -26,6 +26,23 @@ jobs:
       - name: run tests
         run:  npm test
 
+  publish-gh-pages:
+    needs:   build
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: create docs
+        run:  npm run docs
+
+      - name: publish GitHub pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ GITHUB_TOKEN }}
+          publish_dir:  ./docs
+
   publish-dlx:
     needs:   build
     runs-on: ubuntu-latest

.gitignore

@@ -217,3 +217,4 @@ node_modules/
 
 # custom
 nodemon.json
+docs

docs/CNAME CNAMEdocs/CNAME renamed to CNAME

@@ -1,4 +1,5 @@
 <!-- This readme is targeted at developers. The general user readme is in /.github/README.md -->
+
 # Data Format for Digital Linguistics (Daffodil)
 
 The DLx data format is a standardized, human-readable, web-compatible format for storing linguistic data, following best practices for managing data on the modern web. It is part of a broader project called [Digital Linguistics][About] (DLx), which has the goal of creating web tools for managing linguistic data. This project will be useful for anyone who manages a linguistic database.
@@ -17,7 +18,7 @@ Please consider citing this specification in scholarly articles using this repos
 [![npm downloads](https://img.shields.io/npm/dt/@digitallinguistics/spec.svg)][npm]
 [![GitHub issues](https://img.shields.io/github/issues/digitallinguistics/spec.svg)][Issues]
 [![npm version](https://badge.fury.io/js/%40digitallinguistics%2Fspec.svg)][npm]
-[![Build Status](https://travis-ci.org/digitallinguistics/spec.svg?branch=master)][Travis]
+[![Build Status](https://github.com/digitallinguistics/spec/workflows/test/badge.svg)][Actions]
 [![license](https://img.shields.io/github/license/digitallinguistics/spec.svg)][License]
 [![DOI](https://zenodo.org/badge/50221632.svg)][Zenodo]
 
@@ -177,6 +178,7 @@ The DLx format is also compatible with the [Newline Delimited JSON (NDJSON) form
 Tests are run using [Jasmine][Jasmine] in Node.js. Run them from the command line using `npm test`.
 
 [About]:        https://digitallinguistics.io/about
+[Actions]:      https://github.com/digitallinguistics/spec/actions
 [ajv]:          https://www.npmjs.com/package/ajv
 [Contributing]: https://github.com/digitallinguistics/spec/blob/master/.github/CONTRIBUTING.md
 [DateTime]:     https://www.w3.org/TR/NOTE-datetime
@@ -188,7 +190,6 @@ Tests are run using [Jasmine][Jasmine] in Node.js. Run them from the command lin
 [NDJSON]:       http://ndjson.org/
 [npm]:          https://www.npmjs.com/package/@digitallinguistics/spec
 [JSON Schema]:  http://json-schema.org/
-[Travis]:       https://travis-ci.org/digitallinguistics/spec
 [UUID]:         https://www.uuidgenerator.net/
 [Validators]:   http://json-schema.org/implementations.html#validators
 [Zenodo]:       http://doi.org/10.5281/zenodo.594557