brexhq
diff --git a/‎.devcontainer/Dockerfile
Lines changed: 9 additions & 16 deletions b/‎.devcontainer/Dockerfile
Lines changed: 9 additions & 16 deletions
diff --git a/‎.devcontainer/devcontainer.json
Lines changed: 12 additions & 8 deletions b/‎.devcontainer/devcontainer.json
Lines changed: 12 additions & 8 deletions
diff --git a/‎.devcontainer/install-dev-tools.sh
Lines changed: 0 additions & 2 deletions b/‎.devcontainer/install-dev-tools.sh
Lines changed: 0 additions & 2 deletions
diff --git a/‎.github/media/substation_architecture.png
1.21 MB b/‎.github/media/substation_architecture.png
1.21 MB
diff --git a/‎substation_logo.png renamed to ‎.github/media/substation_logo.png b/‎substation_logo.png renamed to ‎.github/media/substation_logo.png
diff --git a/‎.github/workflows/code.yml
Lines changed: 15 additions & 4 deletions b/‎.github/workflows/code.yml
Lines changed: 15 additions & 4 deletions
diff --git a/‎.github/workflows/release_please.yml
Lines changed: 0 additions & 3 deletions b/‎.github/workflows/release_please.yml
Lines changed: 0 additions & 3 deletions
diff --git a/‎.gitignore
Lines changed: 5 additions & 9 deletions b/‎.gitignore
Lines changed: 5 additions & 9 deletions
diff --git a/‎CONTRIBUTING.md
Lines changed: 10 additions & 12 deletions b/‎CONTRIBUTING.md
Lines changed: 10 additions & 12 deletions
@@ -1,21 +1,14 @@
-FROM mcr.microsoft.com/vscode/devcontainers/go:1.19
+FROM mcr.microsoft.com/vscode/devcontainers/go:1.20
 RUN apt-get update -y && \
-    # install Terraform
-    cd /tmp/ && \
-    curl https://releases.hashicorp.com/terraform/1.1.7/terraform_1.1.7_linux_$(dpkg --print-architecture).zip -o ./terraform.zip && \
-    unzip terraform.zip && \
-    mv terraform /usr/local/bin/terraform && \
-    # install Jsonnet
+    # https://developer.hashicorp.com/terraform/downloads
+    wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg && \
+    echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | tee /etc/apt/sources.list.d/hashicorp.list && \
+    apt update -y && apt install -y terraform && \
+    # go-jsonnet
     go install github.com/google/go-jsonnet/cmd/jsonnet@latest && \
     go install github.com/google/go-jsonnet/cmd/jsonnetfmt@latest && \
     go install github.com/google/go-jsonnet/cmd/jsonnet-lint@latest && \
-    # install AWS CLI
+    # AWS CLI
     apt-get install -y awscli && \
-    # install pip and boto3
-    apt-get install -y python3-pip && pip3 install boto3 && pip3 install black && \
-    # install protobuf compiler tools
-    # https://grpc.io/docs/languages/go/quickstart/#prerequisites
-    apt-get install -y protobuf-compiler && \
-    go install google.golang.org/protobuf/cmd/protoc-gen-go@latest && \
-    go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest && \
-    export PATH="$PATH:$(go env GOPATH)/bin"
+    # python
+    apt-get install -y python3 python3-boto3 black
@@ -4,15 +4,19 @@
 		"dockerfile": "Dockerfile"
 	},
 	"remoteUser": "root",
-	"extensions": [
-		"golang.go",
-		"hashicorp.terraform",
-		"zxh404.vscode-proto3",
-		"grafana.vscode-jsonnet"
-	],
 	"runArgs": [
-		"--memory=1g",
+		"--memory=2g",
 		"--cpus=2"
 	],
-	"postCreateCommand": "bash .devcontainer/install-dev-tools.sh"
+	"postCreateCommand": "bash .devcontainer/install-dev-tools.sh",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-vscode.go",
+				"hashicorp.terraform",
+				"zxh404.vscode-proto3",
+				"grafana.vscode-jsonnet"
+			]
+		}
+	}
 }
@@ -1,6 +1,4 @@
 # download go packages
 go mod download
-# compile protobuf
-sh build/scripts/proto/compile.sh
 # compile configurations
 sh build/scripts/config/compile.sh
@@ -39,9 +39,20 @@ jobs:
           pip3 install black
           find -name *.py | xargs black --check
 
-  proto:
+  jsonnet:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: bufbuild/buf-setup-action@v1
-      - uses: bufbuild/buf-lint-action@v1
+      - name: checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      - name: setup
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.19
+
+      - name: compile
+        run: |
+          go install github.com/google/go-jsonnet/cmd/jsonnet@latest
+          sh build/scripts/config/compile.sh
@@ -14,6 +14,3 @@ jobs:
         with:
           release-type: go
           package-name: release-please-action
-          # beta changes are v0.x
-          bump-minor-pre-major: true
-          bump-patch-for-minor-pre-major: true
@@ -12,19 +12,15 @@ CHANGELOG.md
 
 # ignore all JSON by default
 *.json
+*.jsonl
 # allow Visual Studio Code devcontainer config file
 !.devcontainer/devcontainer.json
 # allow Visual Studio Code settings config file
 !.vscode/settings.json
-# allow static JSON files in the examples/ directory
-!examples/condition/data.json
-!examples/*/data.json
-!examples/quickstart/data.json
-# ignore playground files
-playground.wasm
-playground.wasm.gz
-wasm_exec.js
-build/playground/substation_logo.png
+# allow specific JSON files in the examples/ directory
+!examples/**/data*.json
+!examples/**/data*.jsonl
+!examples/**/stdout.jsonl
 
 # Go profiling files
 *.prof
 
@@ -55,13 +55,11 @@ We rely on contributors to test changes before they are submitted as pull reques
 
 #### Environment Variables
 
-Substation uses environment variables to customize runtime settings of the system (e.g., concurrency is controlled by `SUBSTATION_CONCURRENCY`). 
-
-Custom applications should implement their own runtime settings as required; for example, the [AWS Lambda application](/cmd/aws/lambda/substation/) uses `SUBSTATION_HANDLER` to manage [invocation settings](https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html).
+Applications may implement runtime settings that are managed by environment variables. For example, the [AWS Lambda application](/cmd/aws/lambda/substation/) uses `SUBSTATION_HANDLER` to manage [invocation settings](https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html).
 
 #### Configurations
 
-Substation uses a single configuration pattern for all components in the system (see `Config` in [config/config.go](/config/config.go)). This pattern is highly reusable and should be nested to create complex configurations supported by Jsonnet. Below is an example that shows how configurations should be designed:
+Substation uses a single configuration pattern for all components in the system (see `Config` in [config/config.go](/config/config.go)). This pattern is highly reusable and should be embedded to create custom configurations. Below is an example that shows how configurations should be designed:
 
 ```json
    "foo": {
@@ -81,13 +79,13 @@ Substation uses a single configuration pattern for all components in the system
    }
 ```
 
-Repeating this pattern allows components and applications to integrate with the factory pattern.
+Repeating this pattern allows components and applications to integrate with Substation's factory patterns.
 
 #### Factories
 
-Substation relies on [factory methods](https://refactoring.guru/design-patterns/factory-method) to create objects that [satisfy interfaces](https://go.dev/doc/effective_go#interface_methods) across the system. Factories should be combined with the configuration design pattern to create pre-configured, ready-to-use objects.
+Substation relies on [factory methods](https://refactoring.guru/design-patterns/factory-method) to create objects that [satisfy interfaces](https://go.dev/doc/effective_go#interface_methods) across the project. Factories should be combined with the configuration design pattern to create new components.
 
-Factories are the preferred method for allowing users to customize the system. Example factories can be seen in [condition](/condition/condition.go) and [process](/process/process.go).
+Factories are the preferred method for allowing users to customize the system. Example factories can be seen in [condition](/condition/condition.go) and [transform](/transform/transform.go).
 
 #### Reading and Writing Streaming Data
 
@@ -103,9 +101,9 @@ Substation commonly uses these io compatible containers:
 
 #### Errors
 
-Errors should always start with `err` (or `Err`, if they are public) and be defined as constants using [internal/errors](/internal/errors/errors.go).
+Errors should always start with `err` (or `Err`, if they are public). Commonly used errors are defined in [internal/errors.go](internal/errors.go).
 
-If the error is related to an object created by an interface factory, then the object should be referenced by name in the error. For example, if the factory returns objects named `Foo`, `Bar`, and `Baz`, then related errors should be `errFooShortDescription`, `errBarShortDescription`, and `errBazShortDescription`.
+If the error is related to a specific component, then the component name should be included in the error. For example, if the error is related to the `Foo` component, then the error should be named `errFooShortDescription`.
 
 #### Environment Variables
 
@@ -115,15 +113,15 @@ Any environment variable that changes a default runtime setting should always st
 
 #### Application Variables
 
-Variable names should always follow conventions from [Effective Go](https://go.dev/doc/effective_go#names), the [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments#variable-names) and avoid [predeclared identifiers](https://go.dev/ref/spec#Predeclared_identifiers). For example `capsule` is used instead of `cap` to avoid shadowing the capacity function while modifiers and plural usage are `newCapsule` and `capsules`.
+Variable names should always follow conventions from [Effective Go](https://go.dev/doc/effective_go#names), the [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments#variable-names) and avoid [predeclared identifiers](https://go.dev/ref/spec#Predeclared_identifiers).
 
 #### Source Metadata
 
-Sources that [add metadata during encapsulation](/config/README.md) should use lowerCamelCase for their JSON keys.
+Sources that [add metadata during message creation](/message/) should use lowerCamelCase for their JSON keys.
 
 #### Package Configurations
 
-Configurations for packages (for example, [process](/process/README.md) and [condition](/condition/README.md)) should always use lower_snake_case in their JSON keys. This helps maintain readability when reviewing large configuration files.
+Configurations for packages (for example, [condition](/condition/README.md) and [transform](/transform/README.md)) should always use lower_snake_case in their JSON keys. This helps maintain readability when reviewing large configuration files.
 
 We strongly urge everyone to use Jsonnet for managing configurations.