Feat/Github submodules for gbfs schemas (#187)

replace gbfs schemas with git submodule

.github/workflows/publish_validator.yml

@@ -53,6 +53,9 @@ jobs:
         steps:
             - name: Checkout repository
               uses: actions/checkout@v2
+              with:
+                submodules: true
+                fetch-depth: 0
 
             - name: Setup Node.js
               uses: actions/setup-node@v2

.gitignore

@@ -23,6 +23,3 @@ functions/*.zip
 
 .env
 
-# schemas
-
-gbfs-validator/versions/schemas/.*

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "gbfs-validator/versions/gbfs-json-schema"]
+	path = gbfs-validator/versions/gbfs-json-schema
+	url = https://github.com/MobilityData/gbfs-json-schema.git

README.md

@@ -12,7 +12,7 @@ This tool is built using the [JSON Schemas](https://github.com/MobilityData/gbfs
 
 ![interface](https://github.com/MobilityData/gbfs-validator/assets/2423604/11206e7a-dd64-4133-bb32-eaa391815e60)
 
-The schemas in `gbfs-validator/versions/schemas` is a git subtree of https://github.com/MobilityData/gbfs-json-schema. For more details, see [`gbfs-validator/versions/schemas/README.md`](https://github.com/MobilityData/gbfs-validator/tree/master/gbfs-validator/versions).
+The schemas in `gbfs-validator/versions/gbfs-json-schema` is a git submodule of https://github.com/MobilityData/gbfs-json-schema.
 
 Questions? Please open an issue or reach out on the #gbfs channel on the [MobilityData Slack](https://mobilitydata-io.slack.com/).
 

gbfs-validator/gbfs.js

@@ -451,7 +451,7 @@ class GBFS {
     let schema
 
     try {
-      schema = require(`./versions/schemas/v${version}/${file}`)
+      schema = require(`./versions/gbfs-json-schema/v${version}/${file}`)
     } catch (e) {
       console.log(e)
       throw new Error('can not require')

gbfs-validator/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gbfs-validator",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "author": "MobilityData",
   "main": "index.js",
   "license": "MIT",
@@ -19,7 +19,8 @@
     "gbfs-validator": "./cli.js"
   },
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "postinstall": "git submodule update --init --recursive"
   },
   "dependencies": {
     "ajv": "^8.9.0",
@@ -42,6 +43,9 @@
       "!**/coverage/**",
       "!**/__test__/**",
       "!**/schema/**"
+    ],
+    "testPathIgnorePatterns": [
+      "versions/gbfs-json-schema/"
     ]
   }
 }

gbfs-validator/versions/README.md

@@ -4,17 +4,13 @@ This folder contains json schemas from `MobilityData/gbfs-json-schema` and addit
 
 ## JSON schemas
 
-The `schemas` folder contains a [git subtree](https://www.atlassian.com/git/tutorials/git-subtree) of https://github.com/MobilityData/gbfs-json-schema.
+The `schemas` folder contains a [git submodule](https://www.atlassian.com/git/tutorials/git-submodule) of https://github.com/MobilityData/gbfs-json-schema.
 
-You can pull schema update by using the command `git subtree pull --prefix gbfs-validator/versions/schemas https://github.com/MobilityData/gbfs-json-schema.git master --squash`
+You can pull schema update by using the command `git submodule update --init --recursive`
 
-### Contributing back
+## gbfs-json-schema
 
-If you want to push a contribution to the schemas sub-project (`MobilityData/gbfs-json-schema`), you can use the command
+This directory is a git submodule, making changes in this directory is not recommended 
 
-```
-git subtree push --prefix=gbfs-validator/versions/schemas/ https://github.com/MobilityData/gbfs-json-schema.git BRANCH
-```
+If you would like to make changes to `gbfs-json-schema` it is recommended to make a pull request from the original repository [gbfs-json-schema](https://github.com/MobilityData/gbfs-json-schema)
 
-:warning: You probably don't have write access on `MobilityData/gbfs-json-schema`.
-Please, fork it before and replace the repository url with your forked repository url.