Cleaning up Gulp tasks, readme, and testing for GitHub action.

Author: jessefreeman

.github/workflows/pixel-vision-8-release-builder.yml

@@ -63,24 +63,6 @@ jobs:
           IFS='.' read -ra my_array <<< "${{ steps.compute_tag.outputs.next_tag }}"
           echo "CURRENT=${my_array[0]:1}.$((${my_array[1]} - 1)).$((${my_array[2]}))" >> $GITHUB_ENV
           echo "PREVIOUS=${my_array[0]:1}.$((${my_array[1]} - 2)).0" >> $GITHUB_ENV
-      # - name: Create Changelog
-      #   id: changelog
-      #   uses: jimschubert/beast-changelog-action@v1
-      #   with:
-      #     FROM: v${{ env.PREVIOUS }}
-      #     TO: v${{ env.CURRENT }}
-
-      # - name: View Changelog
-      #   run: cat .github/CHANGELOG.md
-
-      # - name: save Changelog
-      #   id: log
-      #   run: |
-      #     REPORT="$(cat .github/CHANGELOG.md)"
-      #     REPORT="${REPORT//'%'/'%25'}"
-      #     REPORT="${REPORT//$'\n'/'%0A'}"
-      #     REPORT="${REPORT//$'\r'/'%0D'}"
-      #     echo "REPORT=$REPORT" >> $GITHUB_ENV
 
      # Setup dotnet v5.0.x
       - name: Setup .NET Core
@@ -99,6 +81,7 @@ jobs:
           npm install gulp -g
           echo $VERSION
           gulp package
+          
       # Update the release with the change log
       - name: Update Release
         id: update_release

Build/Tasks/docs.js

@@ -1,56 +1,56 @@
-// const gulp = require('gulp');
-// const markdownPdf = require('gulp-markdown-pdf');
-// const replace = require('gulp-replace');
-// const path = require("path"); 
-// const fs = require('fs');
+const gulp = require('gulp');
+const markdownPdf = require('gulp-markdown-pdf');
+const replace = require('gulp-replace');
+const path = require("path"); 
+const fs = require('fs');
 
-// gulp.task('docs-concatenate-markdown', function(cb){
+gulp.task('docs-concatenate-markdown', function(cb){
 
-//     var rootPath = path.resolve('Docs/images/') + "/"
+    var rootPath = path.resolve('Docs/images/') + "/"
 
-//     var toc = fs.readFileSync("Docs/_Sidebar.md", "utf8");
+    var toc = fs.readFileSync("Docs/_Sidebar.md", "utf8");
 
-//     var lines = toc.split("\n"); 
+    var lines = toc.split("\n"); 
 
-//     lines.splice(1, 0, "* [About](Home)");
+    lines.splice(1, 0, "* [About](Home)");
 
-//     var markdown = "";
+    var markdown = "";
 
-//     for (let i = 0; i < lines.length; i++) {
+    for (let i = 0; i < lines.length; i++) {
 
-//         const line = lines[i];
+        const line = lines[i];
 
-//         if(line.substring(0,1) == "#")
-//         {
-//             markdown += line
-//         }
-//         else if(line.substring(0,1) == "*")
-//         {
+        if(line.substring(0,1) == "#")
+        {
+            markdown += line
+        }
+        else if(line.substring(0,1) == "*")
+        {
 
-//             let split = line.split("](");
+            let split = line.split("](");
 
-//             markdown += "## " + split[0].substring(3) + "\n";
+            markdown += "## " + split[0].substring(3) + "\n";
 
-//             let text = fs.readFileSync("Docs/" + split[1].substring(0, split[1].length-1) + ".md", "utf8")
+            let text = fs.readFileSync("Docs/" + split[1].substring(0, split[1].length-1) + ".md", "utf8")
 
-//             markdown += text.replace(/\]\(images\//g, "](" + rootPath);;
-//         }
+            markdown += text.replace(/\]\(images\//g, "](" + rootPath);;
+        }
 
-//         markdown += "\n";
+        markdown += "\n";
 
-//     }
+    }
 
-//     fs.writeFile('Releases/Source/docs.md', markdown, cb);
-// });
+    fs.writeFile('Releases/Source/docs.md', markdown, cb);
+});
 
-// gulp.task('docs-build-pdf', function(){
+gulp.task('docs-build-pdf', function(){
 
-//     var tmpDoc = 'Releases/Source/docs.md'
+    var tmpDoc = 'Releases/Source/docs.md'
 
-//     return gulp.src(tmpDoc)
-//     .pipe(markdownPdf())
-//     .pipe(gulp.dest('Releases/Final/'));
+    return gulp.src(tmpDoc)
+    .pipe(markdownPdf())
+    .pipe(gulp.dest('Releases/Final/'));
 
-//   })
+  })
 
-//   gulp.task("build-docs", gulp.series('docs-concatenate-markdown', 'docs-build-pdf'));
+  gulp.task("build-docs", gulp.series('docs-concatenate-markdown', 'docs-build-pdf'));

Game/Src/scene-editor-brush.lua

@@ -1,7 +1,7 @@
 --[[
     ## Space Station 8 `editor-plugin-brush.lua`
 
-]]
+]]--
 
 INPUT_TIMER = "InputTimer"
 BLINK_TIMER = "BlinkTimer"

Game/Src/scene-editor-mouse.lua

@@ -1,7 +1,8 @@
 --[[
     ## Space Station 8 `editor-plugin-mouse.lua`
 
-]]
+]]--
+
 MOUSE_TIMER = "MouseTimer"
 
 -- Create the plugin table

Game/Src/scene-editor-options.lua

@@ -1,7 +1,7 @@
 --[[
     ## Space Station 8 `editor-plugin-options.lua`
 
-]]
+]]--
 
 -- Create the plugin table
 local editorPlugin = {

README.md

@@ -1,4 +1,5 @@
 # Space Station 8
+![Pixel Vision 8](https://github.com/PixelVision8/SpaceStation8/workflows/Space%20Station%208/badge.svg)
 
 **Space Station 8** is a `Micro Platformer` created [in 72 hours for Ludum Dare 49](https://ldjam.com) based on a game I used to play on my original Macintosh called [Spacestation Pheta](https://en.wikipedia.org/wiki/Spacestation_Pheta). Space Station 8 is also heavily inspired by [Bitsy](http://make.bitsy.org) and my Fantasy Console, [Pixel Vision 8](https://pixelvision8.com), which I used to create the game.
 

package.json

@@ -9,15 +9,19 @@
   "author": "Jesse Freeman",
   "license": "ISC",
   "dependencies": {
+    "chokidar": "^3.5.2",
     "del": "^6.0.0",
     "gulp": "^4.0.2",
     "gulp-dotnet-cli": "^1.1.0",
+    "gulp-markdown-pdf": "^8.0.0",
     "gulp-rename": "^2.0.0",
+    "gulp-replace": "^1.1.3",
+    "gulp-shell": "^0.8.0",
     "gulp-string-replace": "^1.1.2",
     "gulp-zip": "^5.1.0",
     "require-dir": "^1.2.0",
+    "tutorial-writer": "^0.1.4",
     "xmldom": "^0.6.0",
-    "xpath": "^0.0.32",
-    "gulp-shell": "^0.8.0"
+    "xpath": "^0.0.32"
   }
 }