ci: ensure README contains all packages in repo (#283)

.github/workflows/package-pr.yaml

@@ -1,4 +1,4 @@
-name: 'Package Pull Requests'
+name: "Package Pull Requests"
 
 on:
   pull_request:
@@ -8,16 +8,37 @@ on:
       - reopened
       - synchronize
     paths:
-      - 'packages/**'
+      - "packages/**"
 
 jobs:
+  check-pkg:
+    name: Validate README
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Get list of changed files
+        uses: lots0logs/gh-action-get-changed-files@2.1.4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Ensure README was updated
+        run: |
+          MISSING_LINES=$(comm -23 <(jq 'if .provides then .provides[].language else .language end' -r $(find packages -name "metadata.json" ) | sed -e 's/^/`/g' -e 's/$/`,/g' | sort -u) <(awk '/# Supported Languages/{flag=1; next} /<br>/{flag=0} flag' readme.md | sort -u))
+
+          [[ $(echo $MISSING_LINES | wc -c) = "1" ]] && exit 0
+
+          echo "README has supported languages missing: "
+          comm -23 <(jq 'if .provides then .provides[].language else .language end' -r $(find packages -name "metadata.json" ) | sed -e 's/^/`/g' -e 's/$/`,/g' | sort -u) <(awk '/# Supported Languages/{flag=1; next} /<br>/{flag=0} flag' readme.md | sort -u)
+          exit 1
+
   build-pkg:
     name: Check that package builds
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      
+
       - name: Login to GitHub registry
         uses: docker/login-action@v1
         with:
@@ -29,7 +50,7 @@ jobs:
         uses: lots0logs/gh-action-get-changed-files@2.1.4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-                
+
       - name: Build Packages
         run: |
           PACKAGES=$(jq '.[]' -r ${HOME}/files.json | awk -F/ '{ print $2 "-" $3 }' | sort -u)
@@ -43,7 +64,6 @@ jobs:
           name: packages
           path: packages/*.pkg.tar.gz
 
-
   test-pkg:
     name: Test package
     runs-on: ubuntu-latest
@@ -54,7 +74,7 @@ jobs:
       - uses: actions/download-artifact@v2
         with:
           name: packages
-      
+
       - name: Relocate downloaded packages
         run: mv *.pkg.tar.gz packages/
 
@@ -109,17 +129,8 @@ jobs:
             done
           done
 
-
       - name: Dump logs
         if: ${{ always() }}
         run: |
           docker logs api
           docker logs repo
-
-
-
-
-
-
-
-

readme.md

@@ -37,6 +37,7 @@
 </h4>
 
 ---
+
 <br>
 
 # About
@@ -49,16 +50,19 @@
 <br>
 
 It's used in numerous places including:
-* [EMKC Challenges](https://emkc.org/challenges)
+
-* [EMKC Weekly Contests](https://emkc.org/contests)
+- [EMKC Challenges](https://emkc.org/challenges)
-* [Engineer Man Discord Server](https://discord.gg/engineerman)
+- [EMKC Weekly Contests](https://emkc.org/contests)
-* Web IDEs
+- [Engineer Man Discord Server](https://discord.gg/engineerman)
-* 200+ direct integrations
+- Web IDEs
+- 200+ direct integrations
 
 <br>
 
 ### Official Extensions
+
 The following are approved and endorsed extensions/utilities to the core Piston offering.
+
 - [I Run Code](https://github.com/engineer-man/piston-bot), a Discord bot used in 4100+ servers to handle arbitrary code evaluation in Discord. To get this bot in your own server, go here: https://emkc.org/run.
 - [Piston CLI](https://github.com/Shivansh-007/piston-cli), a universal shell supporting code highlighting, files, and interpretation without the need to download a language.
 
@@ -72,13 +76,15 @@ The following are approved and endorsed extensions/utilities to the core Piston
 <br>
 
 When using the public Piston API, use the following two URLs:
+
 ```
 GET  https://emkc.org/api/v2/piston/runtimes
 POST https://emkc.org/api/v2/piston/execute
 ```
+
 > Important Note: The Piston API is rate limited to 5 requests per second. If you have a need for more requests than that
-and it's for a good cause, please reach out to me (EngineerMan#0001) on [Discord](https://discord.gg/engineerman)
+> and it's for a good cause, please reach out to me (EngineerMan#0001) on [Discord](https://discord.gg/engineerman)
-so we can discuss potentially getting you an unlimited key.
+> so we can discuss potentially getting you an unlimited key.
 
 <br>
 
@@ -109,8 +115,8 @@ docker-compose up -d api
 cd cli && npm i && cd -
 ```
 
-The API will now be online with no language runtimes installed. To install runtimes, [use the CLI](#cli).        
+The API will now be online with no language runtimes installed. To install runtimes, [use the CLI](#cli).
-        
+
 ## Just Piston (no CLI)
 
 ### Host System Package Dependencies
@@ -172,11 +178,13 @@ The container exposes an API on port 2000 by default.
 This is used by the CLI to carry out running jobs and package management.
 
 #### Runtimes Endpoint
+
 `GET /api/v2/runtimes`
 This endpoint will return the supported languages along with the current version and aliases. To execute
 code for a particular language using the `/api/v2/execute` endpoint, either the name or one of the aliases must
 be provided, along with the version.
 Multiple versions of the same language may be present at the same time, and may be selected when running a job.
+
 ```json
 HTTP/1.1 200 OK
 Content-Type: application/json
@@ -201,47 +209,47 @@ Content-Type: application/json
 ```
 
 #### Execute Endpoint
+
 `POST /api/v2/execute`
 This endpoint requests execution of some arbitrary code.
+
 - `language` (**required**) The language to use for execution, must be a string and must be installed.
 - `version` (**required**) The version of the language to use for execution, must be a string containing a SemVer selector for the version or the specific version number to use.
 - `files` (**required**) An array of files containing code or other data that should be used for execution. The first file in this array is considered the main file.
-- `files[].name` (*optional*) The name of the file to upload, must be a string containing no path or left out.
+- `files[].name` (_optional_) The name of the file to upload, must be a string containing no path or left out.
 - `files[].content` (**required**) The content of the files to upload, must be a string containing text to write.
-- `stdin` (*optional*) The text to pass as stdin to the program. Must be a string or left out. Defaults to blank string.
+- `stdin` (_optional_) The text to pass as stdin to the program. Must be a string or left out. Defaults to blank string.
-- `args` (*optional*) The arguments to pass to the program. Must be an array or left out. Defaults to `[]`.
+- `args` (_optional_) The arguments to pass to the program. Must be an array or left out. Defaults to `[]`.
-- `compile_timeout` (*optional*) The maximum time allowed for the compile stage to finish before bailing out in milliseconds. Must be a number or left out. Defaults to `10000` (10 seconds).
+- `compile_timeout` (_optional_) The maximum time allowed for the compile stage to finish before bailing out in milliseconds. Must be a number or left out. Defaults to `10000` (10 seconds).
-- `run_timeout` (*optional*) The maximum time allowed for the run stage to finish before bailing out in milliseconds. Must be a number or left out. Defaults to `3000` (3 seconds).
+- `run_timeout` (_optional_) The maximum time allowed for the run stage to finish before bailing out in milliseconds. Must be a number or left out. Defaults to `3000` (3 seconds).
-- `compile_memory_limit` (*optional*) The maximum amount of memory the compile stage is allowed to use in bytes. Must be a number or left out. Defaults to `-1` (no limit)
+- `compile_memory_limit` (_optional_) The maximum amount of memory the compile stage is allowed to use in bytes. Must be a number or left out. Defaults to `-1` (no limit)
-- `run_memory_limit` (*optional*) The maximum amount of memory the run stage is allowed to use in bytes. Must be a number or left out. Defaults to `-1` (no limit)
+- `run_memory_limit` (_optional_) The maximum amount of memory the run stage is allowed to use in bytes. Must be a number or left out. Defaults to `-1` (no limit)
 
 ```json
 {
-    "language": "js",
+  "language": "js",
-    "version": "15.10.0",
+  "version": "15.10.0",
-    "files": [
+  "files": [
-        {
+    {
-            "name": "my_cool_code.js",
+      "name": "my_cool_code.js",
-            "content": "console.log(process.argv)"
+      "content": "console.log(process.argv)"
-        }
+    }
-    ],
+  ],
-    "stdin": "",
+  "stdin": "",
-    "args": [
+  "args": ["1", "2", "3"],
-        "1",
+  "compile_timeout": 10000,
-        "2",
+  "run_timeout": 3000,
-        "3"
+  "compile_memory_limit": -1,
-    ],
+  "run_memory_limit": -1
-    "compile_timeout": 10000,
-    "run_timeout": 3000,
-    "compile_memory_limit": -1,
-    "run_memory_limit": -1
 }
 ```
+
 A typical response upon successful execution will contain 1 or 2 keys `run` and `compile`.
 `compile` will only be present if the language requested requires a compile stage.
 
 Each of these keys has an identical structure, containing both a `stdout` and `stderr` key, which is a string containing the text outputted during the stage into each buffer.
 It also contains the `code` and `signal` which was returned from each process.
+
 ```json
 HTTP/1.1 200 OK
 Content-Type: application/json
@@ -260,6 +268,7 @@ Content-Type: application/json
 ```
 
 If a problem exists with the request, a `400` status code is returned and the reason in the `message` key.
+
 ```json
 HTTP/1.1 400 Bad Request
 Content-Type: application/json
@@ -272,40 +281,45 @@ Content-Type: application/json
 <br>
 
 # Supported Languages
+
+`awk`,
 `bash`,
 `brainfuck`,
+`c`,
+`c++`,
 `cjam`,
 `clojure`,
 `cobol`,
 `coffeescript`,
 `cow`,
 `crystal`,
+`csharp`,
+`d`,
 `dart`,
 `dash`,
-`deno`,
 `dotnet`,
 `dragon`,
 `elixir`,
 `emacs`,
 `erlang`,
-`gawk`,
+`fortran`,
-`gcc`,
 `go`,
 `golfscript`,
 `groovy`,
 `haskell`,
 `java`,
+`javascript`,
 `jelly`,
 `julia`,
 `kotlin`,
 `lisp`,
 `lolcode`,
 `lua`,
-`mono`,
 `nasm`,
+`nasm64`,
 `nim`,
-`node`,
 `ocaml`,
+`octave`,
 `osabie`,
 `paradoc`,
 `pascal`,
@@ -314,7 +328,9 @@ Content-Type: application/json
 `ponylang`,
 `prolog`,
 `pure`,
+`pyth`,
 `python`,
+`python2`,
 `raku`,
 `rockstar`,
 `ruby`,
@@ -338,9 +354,11 @@ The source file is either ran or compiled and ran (in the case of languages like
 <br>
 
 # Security
+
 Docker provides a great deal of security out of the box in that it's separate from the system.
 Piston takes additional steps to make it resistant to
 various privilege escalation, denial-of-service, and resource saturation threats. These steps include:
+
 - Disabling outgoing network interaction
 - Capping max processes at 256 by default (resists `:(){ :|: &}:;`, `while True: os.fork()`, etc.)
 - Capping max files at 2048 (resists various file based attacks)
@@ -353,4 +371,5 @@ various privilege escalation, denial-of-service, and resource saturation threats
 <br>
 
 # License
+
 Piston is licensed under the MIT license.