ci: create types packages for "Stats" and "Visualizer" services (#968)

* make stats type package * make stats type package * remove node_modules from `.gitidnore` files of subprojects --------- Co-authored-by: Rim Rakhimov <[email protected]>
blockscout · Jul 5, 2024 · cde3965 · cde3965
1 parent 748f55a
commit cde3965
Show file tree

Hide file tree

Showing 27 changed files with 493 additions and 15 deletions.
diff --git a/.github/workflows/npm-publisher.yml b/.github/workflows/npm-publisher.yml
@@ -12,6 +12,8 @@ on:
                 type: choice
                 options:
                     - blockscout-ens
+                    - stats
+                    - visualizer
                 required: true
     workflow_call:
         inputs:

diff --git a/.github/workflows/stats.yml b/.github/workflows/stats.yml
@@ -84,3 +84,13 @@ jobs:
     uses: ./.github/workflows/_docker-build-push.yml
     with:
       service-name: stats
+
+  publish_types_package:
+    name: Publish types package
+    uses: './.github/workflows/npm-publisher.yml'
+    needs: docker
+    if: needs.docker.outputs.tag-value != ''
+    secrets: inherit
+    with:
+      version: ${{ needs.docker.outputs.tag-value }}
+      project_name: stats
diff --git a/.github/workflows/visualizer.yml b/.github/workflows/visualizer.yml
@@ -74,3 +74,13 @@ jobs:
     uses: ./.github/workflows/_docker-build-push.yml
     with:
       service-name: visualizer
+
+  publish_types_package:
+    name: Publish types package
+    uses: './.github/workflows/npm-publisher.yml'
+    needs: docker
+    if: needs.docker.outputs.tag-value != ''
+    secrets: inherit
+    with:
+      version: ${{ needs.docker.outputs.tag-value }}
+      project_name: visualizer
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,9 @@ config.toml
 ## Cargo.lock for libs
 libs/Cargo.lock
 
+## NPM dependencies
+**/node_modules/**
+
 ## Secrets
 **.decrypted~**
 **.dec**
diff --git a/blockscout-ens/.gitignore b/blockscout-ens/.gitignore
@@ -1,3 +1,2 @@
-node_modules
 .env
 .env.*
diff --git a/blockscout-ens/graph-node/.gitignore b/blockscout-ens/graph-node/.gitignore
@@ -1,4 +1,3 @@
 data
-node_modules
 *.ipynb
 .venv
diff --git a/...-ens/graph-node/subgraph-writer/templater/{{cookiecutter.short_name}}-subgraph/.gitignore b/...-ens/graph-node/subgraph-writer/templater/{{cookiecutter.short_name}}-subgraph/.gitignore
@@ -42,7 +42,6 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 dist/
 

diff --git a/blockscout-ens/graph-node/subgraphs/bns-subgraph/.gitignore b/blockscout-ens/graph-node/subgraphs/bns-subgraph/.gitignore
@@ -41,7 +41,6 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 dist/
 

diff --git a/blockscout-ens/graph-node/subgraphs/ens-subgraph/.gitignore b/blockscout-ens/graph-node/subgraphs/ens-subgraph/.gitignore
@@ -41,7 +41,6 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 dist/
 

diff --git a/blockscout-ens/graph-node/subgraphs/genome-subgraph/.gitignore b/blockscout-ens/graph-node/subgraphs/genome-subgraph/.gitignore
@@ -43,7 +43,6 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 dist/
 

diff --git a/blockscout-ens/graph-node/subgraphs/lightlink-subgraph/.gitignore b/blockscout-ens/graph-node/subgraphs/lightlink-subgraph/.gitignore
@@ -42,7 +42,6 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 dist/
 

diff --git a/blockscout-ens/graph-node/subgraphs/mode-subgraph/.gitignore b/blockscout-ens/graph-node/subgraphs/mode-subgraph/.gitignore
@@ -42,7 +42,6 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 dist/
 

diff --git a/blockscout-ens/graph-node/subgraphs/rns-subgraph/.gitignore b/blockscout-ens/graph-node/subgraphs/rns-subgraph/.gitignore
@@ -43,7 +43,6 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 dist/
 

diff --git a/blockscout-ens/graph-node/subgraphs/zns-subgraph/.gitignore b/blockscout-ens/graph-node/subgraphs/zns-subgraph/.gitignore
@@ -43,7 +43,6 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
 jspm_packages/
 dist/
 

diff --git a/blockscout-ens/types/.gitignore b/blockscout-ens/types/.gitignore
@@ -1,2 +1 @@
-/node-modules
 /dist
diff --git a/libs/blockscout-client/.gitignore b/libs/blockscout-client/.gitignore
@@ -1 +0,0 @@
-node_modules

diff --git a/multichain-search/frontend/.gitignore b/multichain-search/frontend/.gitignore
@@ -1,7 +1,6 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 .env
 # dependencies
-*node_modules*
 /.pnp
 .pnp.js
 

diff --git a/smart-guessr/.gitignore b/smart-guessr/.gitignore
@@ -1,7 +1,6 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
 # dependencies
-/node_modules
 /.pnp
 .pnp.js
 

diff --git a/stats/types/.gitignore b/stats/types/.gitignore
@@ -0,0 +1 @@
+/dist
diff --git a/stats/types/.npmignore b/stats/types/.npmignore
@@ -0,0 +1 @@
+/node_modules
diff --git a/stats/types/package-lock.json b/stats/types/package-lock.json
diff --git a/stats/types/package.json b/stats/types/package.json
@@ -0,0 +1,26 @@
+{
+  "name": "@blockscout/stats-types",
+  "version": "0.0.1",
+  "description": "TypeScript definitions for Stats microservice",
+  "main": "./dist/stats-proto/proto/stats.js",
+  "types": "./dist/stats-proto/proto/stats.d.ts",
+  "scripts": {
+    "build": "npm run compile:proto && npm run compile:ts",
+    "compile:proto": "mkdir -p ./dist && protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_opt=snakeToCamel=false --ts_proto_opt=stringEnums=true --ts_proto_opt=onlyTypes=true --ts_proto_opt=emitImportedFiles=false --proto_path=../ --proto_path=../../proto/ --ts_proto_out=./dist ../stats-proto/proto/stats.proto",
+    "compile:ts": "tsc --declaration ./dist/stats-proto/proto/stats.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/blockscout/blockscout-rs.git",
+    "directory": "stats/types"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/blockscout/blockscout-rs/issues"
+  },
+  "homepage": "https://github.com/blockscout/blockscout-rs#readme",
+  "devDependencies": {
+    "ts-proto": "1.176.2",
+    "typescript": "5.4.5"
+  }
+}
diff --git a/visualizer/.gitignore b/visualizer/.gitignore
@@ -16,6 +16,5 @@ Session.vim
 
 ## Build
 /target
-**/node_modules/**
 config.toml
 output
diff --git a/visualizer/types/.gitignore b/visualizer/types/.gitignore
@@ -0,0 +1 @@
+/dist
diff --git a/visualizer/types/.npmignore b/visualizer/types/.npmignore
@@ -0,0 +1 @@
+/node_modules