docs: update references to documentation. (#23)

* chore: update ci deps.

* ci: publish workflow.

Author: morganney

.github/workflows/ci.yml

@@ -14,15 +14,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.5.2
+        uses: actions/checkout@v4.1.1
       - name: Setup Node
-        uses: actions/setup-node@v3.6.0
+        uses: actions/setup-node@v4.0.2
         with:
-          node-version: '20.10.0'
+          node-version: '20.11.0'
       - name: Install Dependencies
         run: npm ci
       - name: Save error log
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4.3.1
         if: ${{ failure() }}
         with:
           name: npm-debug-log-${{ hashFiles('package-lock.json') }}

.github/workflows/deploy.yml

@@ -9,15 +9,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.5.2
+        uses: actions/checkout@v4.1.1
       - name: Setup Node
-        uses: actions/setup-node@v3.6.0
+        uses: actions/setup-node@v4.0.2
         with:
-          node-version: '20.10.0'
+          node-version: '20.11.0'
       - name: Install Dependencies
         run: npm ci
       - name: Save error log
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4.3.1
         if: ${{ failure() }}
         with:
           name: npm-debug-log-${{ hashFiles('package-lock.json') }}

.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    if: contains('["morganney"]', github.actor)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.1.1
+      - name: Setup Node
+        uses: actions/setup-node@v4.0.2
+        with:
+          node-version: '20.11.0'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Save error log
+        uses: actions/upload-artifact@v4.3.1
+        if: ${{ failure() }}
+        with:
+          name: npm-debug-log-${{ hashFiles('package-lock.json') }}
+          path: npm-debug.log
+      - name: Pack
+        run: npm pack
+      - name: Push to NPM registry
+        uses: JS-DevTools/npm-publish@v3.0.1
+        with:
+          token: ${{ secrets.NPM_AUTH_TOKEN }}
+          tag: ${{ contains(github.ref, '-') && 'next' || 'latest' }}

.gitignore

@@ -1,3 +1,4 @@
 *.log
+*.tgz
 node_modules
 dist

README.md

@@ -2,8 +2,8 @@
 
 Converts the [NextBus][1] [Public XML Feed][2], which is used to build real-time transit applications, into a RESTful JSON API.
 
-All documentation is hosted at [restbus.info][0].
+All documentation is hosted at [morganney.github.io/restbus.info][0].
 
-[0]: http://restbus.info
+[0]: https://morganney.github.io/restbus.info
 [1]: https://retro.umoiq.com/
 [2]: https://retro.umoiq.com/xmlFeedDocs/NextBusXMLFeed.pdf

lambda.js

@@ -1,5 +1,5 @@
 /**
- * Used by restbus.info domain for hosting documentation about restbus.
+ * Used by morganney.github.io/restbus.info domain for hosting documentation about restbus.
  */
 const serverlessExpress = require('@codegenie/serverless-express');
 const restbus = require('./lib/restbus');

lib/api/predictions.js

@@ -149,7 +149,7 @@ predictions.get = function (req, res) {
                   title: title
                 });
 
-                // Add a via from-links if needed (tuples and code preds are only known by docs at restbus.info)
+                // Add a via from-links if needed (tuples and code preds are only known by docs at morganney.github.io/restbus.info)
                 if (onsplit === 'routes') {
                   from.push({
                     href: [uri, 'routes/', p.route.id].join(''),

lib/api/routes.js

@@ -97,7 +97,7 @@ routes.list = function (req, res) {
                     self: {
                       href: suri,
                       type: utils.c.MTJSON,
-                      rel: 'http://restbus.info/_links/rel/full',
+                      rel: 'https://morganney.github.io/restbus.info/full.html',
                       rt: C.RTE,
                       title: [
                         'Full configuration for ',
@@ -111,7 +111,7 @@ routes.list = function (req, res) {
                       {
                         href: suri,
                         type: utils.c.MTJSON,
-                        rel: 'http://restbus.info/_links/rel/full',
+                        rel: 'https://morganney.github.io/restbus.info/full.html',
                         rt: C.RTE,
                         title: [
                           'Full configuration for ',

package-lock.json

@@ -1,8 +1,8 @@
 {
   "name": "restbus",
   "description": "RESTful JSON API for the NextBus Inc. public XML feed.",
-  "version": "2.4.0",
-  "main": "index",
+  "version": "2.4.1",
+  "main": "index.js",
   "dependencies": {
     "compression": "1.7.4",
     "express": "4.18.2",
@@ -22,7 +22,7 @@
     "type": "git",
     "url": "https://github.com/morganney/restbus.git"
   },
-  "homepage": "http://restbus.info",
+  "homepage": "https://morganney.github.io/restbus.info",
   "keywords": [
     "umo",
     "nextbus",
@@ -40,7 +40,7 @@
   },
   "license": "MIT",
   "files": [
-    "dist"
+    "lib"
   ],
   "scripts": {
     "prettier": "prettier -w .",