Merge pull request #158 from vegaprotocol/grpc-subdir

Move gRPC files to subdir

Author: ashleyvega

.dockerignore

@@ -1,6 +1,5 @@
-# Exclude auto-generated code, avoid sending it all to the Docker daemon during image build.
-cpp
-go
-java
-js
-python
+# Avoid sending unnecessary data to the Docker daemon during image build.
+.git
+graphql
+grpc/clients
+grpc/doc

.github/workflows/docker.yml

@@ -8,11 +8,7 @@ name: Docker tests
       - develop
       - master
     paths-ignore:
-      - "cpp/**"
-      - "go/**"
-      - "java/**"
-      - "js/**"
-      - "python/**"
+      - "grpc/clients/**"
 
 jobs:
 

.github/workflows/javascript-release.yml

@@ -24,7 +24,7 @@ jobs:
 
       - name: Install
         run: |
-          cd js
+          cd grpc/clients/js
           npm ci
 
       - name: Test
@@ -33,12 +33,12 @@ jobs:
           GRPC_NODE: ${{ secrets.GRPC_NODE }}
           WALLETSERVER: ${{ secrets.WALLETSERVER }}
         run: |
-          cd js
+          cd grpc/clients/js
           npm test
 
       - name: Push release to npm (public)
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
         run: |
-          cd js
+          cd grpc/clients/js
           npm publish --access public .

.github/workflows/javascript.yml

@@ -8,19 +8,21 @@ name: Javascript tests
       - develop
       - master
     paths-ignore:
-      - "cpp/**"
-      - "go/**"
-      - "java/**"
-      - "python/**"
+      - "grpc/clients/cpp/**"
+      - "grpc/clients/go/**"
+      - "grpc/clients/java/**"
+      # do not ignore grpc/clients/js/
+      - "grpc/clients/python/**"
   pull_request:
     branches:
       - develop
       - master
     paths-ignore:
-      - "cpp/**"
-      - "go/**"
-      - "java/**"
-      - "python/**"
+      - "grpc/clients/cpp/**"
+      - "grpc/clients/go/**"
+      - "grpc/clients/java/**"
+      # do not ignore grpc/clients/js/
+      - "grpc/clients/python/**"
 
 jobs:
 
@@ -40,12 +42,12 @@ jobs:
 
       - name: Install
         run: |
-          cd js
+          cd grpc/clients/js
           npm ci
 
       - name: Lint
         run: |
-          cd js
+          cd grpc/clients/js
           npm run lint
 
       - name: Test
@@ -54,5 +56,5 @@ jobs:
           GRPC_NODE: ${{ secrets.GRPC_NODE }}
           WALLETSERVER: ${{ secrets.WALLETSERVER }}
         run: |
-          cd js
+          cd grpc/clients/js
           npm test

.github/workflows/python-alpharelease.yml

@@ -25,7 +25,7 @@ jobs:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.TWINE_TEST_PASSWORD }}
         run: |
-          cd python
+          cd grpc/clients/python
           github_tag="${GITHUB_REF/refs\/tags\/v/}"
           sed --in-place -e 's#^VERSION.*$#VERSION = "'"$github_tag"'"#' setup.py
           setuppy_tag="$(python -c "$(awk '/^VERSION = /' setup.py); print(VERSION)")"

.github/workflows/python-release.yml

@@ -26,7 +26,7 @@ jobs:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
         run: |
-          cd python
+          cd grpc/clients/python
           github_tag="${GITHUB_REF/refs\/tags\/v/}"
           setuppy_tag="$(python -c "$(awk '/^VERSION = /' setup.py); print(VERSION)")"
           if test "$github_tag" '!=' "$setuppy_tag" ; then

.github/workflows/python.yml

@@ -8,19 +8,21 @@ name: Python tests
       - develop
       - master
     paths-ignore:
-      - "cpp/**"
-      - "go/**"
-      - "java/**"
-      - "js/**"
+      - "grpc/clients/cpp/**"
+      - "grpc/clients/go/**"
+      - "grpc/clients/java/**"
+      - "grpc/clients/js/**"
+      # do not ignore grpc/clients/python/
   pull_request:
     branches:
       - develop
       - master
     paths-ignore:
-      - "cpp/**"
-      - "go/**"
-      - "java/**"
-      - "js/**"
+      - "grpc/clients/cpp/**"
+      - "grpc/clients/go/**"
+      - "grpc/clients/java/**"
+      - "grpc/clients/js/**"
+      # do not ignore grpc/clients/python/
 
 jobs:
 
@@ -40,13 +42,13 @@ jobs:
 
       - name: Lint with flake8
         run: |
-          cd python
+          cd grpc/clients/python
           command -v flake8 1>/dev/null || pip install flake8
           make flake8
 
       - name: Lint with black
         run: |
-          cd python
+          cd grpc/clients/python
           command -v black 1>/dev/null || pip install black
           make black
 
@@ -56,7 +58,7 @@ jobs:
           FAUCETSERVER: ${{ secrets.FAUCETSERVER }}
           WALLETSERVER: ${{ secrets.WALLETSERVER }}
         run: |
-          cd python
+          cd grpc/clients/python
           command -v pipenv 1>/dev/null || pip install pipenv
           make test
 
@@ -66,17 +68,17 @@ jobs:
           FAUCETSERVER: ${{ secrets.FAUCETSERVER }}
           WALLETSERVER: ${{ secrets.WALLETSERVER }}
         run: |
-          cd python
+          cd grpc/clients/python
           make coverage
 
       - name: Type-check with mypy
         run: |
-          cd python
+          cd grpc/clients/python
           command -v mypy 1>/dev/null || pip install mypy
           make mypy
 
       - name: Check archive file counts
         run: |
-          cd python
+          cd grpc/clients/python
           python3 setup.py sdist bdist_wheel
           make check_dist

.github/workflows/yamllint.yml

@@ -8,11 +8,7 @@ name: YAML lint
       - develop
       - master
     paths-ignore:
-      - "cpp/**"
-      - "go/**"
-      - "java/**"
-      - "js/**"
-      - "python/**"
+      - "grpc/clients/**"
 
 jobs:
 

Dockerfile

@@ -2,7 +2,7 @@ FROM scratch
 LABEL maintainer="[email protected]"
 
 # Add Vega proto files
-ADD /proto /proto
+ADD /grpc/proto /proto
 
 # Add third party proto files
-ADD /vendor /vendor
+ADD /grpc/vendor /vendor

README.md

@@ -4,10 +4,11 @@ Version: 0.33.0
 
 This repository contains auto-generated gRPC clients for various languages.
 
-## Update process
+## Update process - gRPC
 
 ```bash
 # Copy proto files from Core
+cd grpc
 VEGACORE=/path/to/go/src/vega make preproto
 
 # Generate API clients
@@ -17,6 +18,16 @@ make proto
 GRPC_NODE=veganode.example.com:1234 WALLETSERVER=https://vegawallet.example.com make test
 ```
 
+## Update process - GraphQL
+```bash
+# Copy schema.graphql from Core
+cd graphql
+VEGACORE=/path/to/go/src/vega make pregraphql
+
+# Generate documentation
+make graphql
+```
+
 ## Release process
 
 ```bash