chore: release 0.2 (#110)

ravisuhag · web-flow · commit 3ea04a775a68 · 2022-02-15T23:41:16.000-08:00
* docs: udpate readme

* docs: update banner image

* chore: update js package version

* chore: client readme update

* chore: readme fix
diff --git a/.gitignore b/.gitignore
@@ -12,7 +12,7 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
-# Dependency directories (remove the comment below to include it)
+# Dependency directories
 vendor/
 
 # IDEs
diff --git a/README.md b/README.md
@@ -1,13 +1,11 @@
 # Stencil
 
-![test workflow](https://github.com/odpf/stencil/actions/workflows/server-test.yaml/badge.svg)
-![release workflow](https://github.com/odpf/stencil/actions/workflows/release.yml/badge.svg)
+![Test](https://github.com/odpf/stencil/actions/workflows/test-server.yaml/badge.svg)
+![Release](https://github.com/odpf/stencil/actions/workflows/release.yml/badge.svg)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?logo=apache)](LICENSE)
 [![Version](https://img.shields.io/github/v/release/odpf/stencil?logo=semantic-release)](Version)
 
-Stencil is dynamic schema registry for protobuf. [Protobuf](https://developers.google.com/protocol-buffers) is a Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. The challenge with using generated source code from protobuf is that for every change in proto definition, it requires to recompile dependent services/packages. This approach works for most applications but it's difficult for general purpose applications that needs to operate on arbitrary protobuf schemas. Stencil enables the developers to specifically tackle this problem.
-
-To work with arbitrary proto schema, application need to load proto schema definition at runtime. Protobuf allows you to define a whole proto file using [google.protobuf.FileDescriptorProto](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/descriptor.proto#L62). A [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/descriptor.proto#L57) contains list of FileDescriptorProtos. `protoc` can generate descriptorset file from proto files. Stencil heavily make use of this feature to update proto schemas in runtime.
+Stencil is a schema registry that provides schema mangement and validation to ensure data compatibility across applications. It enables developers to create, manage and consume schemas dynamically, efficiently, and reliably, and provides a simple way to validate data against those schemas. Stencil support multiple formats including Protobuf, Avro and JSON.
 
 <p align="center"><img src="./docs/static/assets/overview.svg" /></p>
 
@@ -20,21 +18,101 @@ Discover why users choose Stencil as their main schema registry
 - **Flexbility** ability to skip some of the backward compatability checks while upload
 - **Descriptor fetch** ability to download proto descriptor files
 - **Metadata** provides metadata API to retrieve latest version number given a name and namespace
-- **Clients in multiple languages** Stencil provides clients in GO, JAVA, JS languages to interact with Stencil server and deserialize messages using dynamic schema
+- **Clients in multiple languages** Stencil provides clients in GO, Java, JS languages to interact with Stencil server and deserialize messages using dynamic schema
 
-## Usage
+## Documentation
 
 Explore the following resources to get started with Stencil:
 
-- [Documentation](http://odpf.gitbook.io/stencil) provides guidance on using stencil.
-- [Server](/server) provides details on getting started with stencil server.
-- [Clients](/clients) provides reference to supported stencil clients.
+- [Documentation](http://odpf.github.io/stencil) provides guidance on using stencil.
+- [Server](https://odpf.github.io/stencil/docs/server/overview) provides details on getting started with stencil server.
+- [Clients](https://odpf.github.io/stencil/docs/clients/overview) provides reference to supported stencil clients.
+
+## Installation
+
+Install Stencil on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine.
+
+#### Binary (Cross-platform)
+
+Download the appropriate version for your platform from [releases](https://github.com/odpf/stencil/releases) page. Once downloaded, the binary can be run from anywhere.
+You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account.
+Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.
+
+#### Homebrew
+
+```sh
+# Install stencil (requires homebrew installed)
+$ brew install odpf/taps/stencil
+
+# Upgrade stencil (requires homebrew installed)
+$ brew upgrade stencil
+
+# Check for installed stencil version
+$ stencil version
+```
+
+## Usage
+
+Stencil has three major components. Server, CLI and clients. Stencil server and CLI are bundled in a single binary.
+
+### Server
+
+Stencil server provides a way to store and fetch schemas and enforce compatability rules. Run `stencil server --help` to see instructions to manage Stencil server.
+
+### CLI
+
+Stencil CLI allows users to iteract with server to create, view, and search schemas. CLI is fully featured but simple to use, even for those who have very limited experience working from the command line. Run `stencil --help` to see list of all available commands and instructions to use.
 
 ## Clients
 
+Stencil clients allows application to interact with stencil server to eserialize and deserialize messages using schema. Stencil supports clients in multiple languages.
+
 - [Java](clients/java)
 - [Go](clients/go)
 - [Javascript](clients/js)
+- Ruby - Coming soon
+- Python - Coming soon
+
+## Running locally
+
+<details>
+  <summary>Dependencies:</summary>
+
+    - Git
+    - Go 1.16 or above
+    - PostgreSQL 13 or above
+
+</details>
+
+```sh
+# Clone the repo
+$ git clone git@github.com:odpf/stencil.git
+
+# Check all build comamnds available
+$ make help
+
+# Build meteor binary file
+$ make build
+
+# Init server config
+$ cp app/config.yaml config.yaml
+
+# Run database migrations
+$ ./stencil server migrate
+
+# Start stencil server
+$ ./stencil server start
+```
+
+## Running tests
+
+```sh
+# Running all unit tests
+$ make test
+
+# Print code coverage
+$ make coverage
+```
 
 ## Contribute
 
@@ -44,8 +122,6 @@ Read our [contributing guide](docs/contribute/contribution.md) to learn about ou
 
 To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/odpf/stencil/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.
 
-## Credits
-
 This project exists thanks to all the [contributors](https://github.com/odpf/stencil/graphs/contributors).
 
 ## License
diff --git a/clients/java/README.md b/clients/java/README.md
@@ -6,8 +6,8 @@ Protobuf allows you to define a protobuf file using DescriptorSet. A FileDescrip
 
 ## Requirements
 
-  - [Gradle v6+](https://gradle.org/)
-  - [JDK 8+](https://openjdk.java.net/projects/jdk8/)
+- [Gradle v6+](https://gradle.org/)
+- [JDK 8+](https://openjdk.java.net/projects/jdk8/)
 
 ## Usage
 
@@ -16,7 +16,7 @@ Protobuf allows you to define a protobuf file using DescriptorSet. A FileDescrip
 #### Gradle
 
 ```groovy
-  implementation group: 'io.odpf', name: 'stencil', version: '0.1.6'
+  implementation group: 'io.odpf', name: 'stencil', version: '0.2.0'
 ```
 
 #### Maven
@@ -42,7 +42,6 @@ import io.odpf.stencil.StencilClientFactory;
 StencilClient stencilClient = StencilClientFactory.getClient();
 ```
 
-
 #### Create client with remote URL
 
 ```java
@@ -53,6 +52,7 @@ StencilClient stencilClient = StencilClientFacorty.getClient(url, StencilConfig.
 ```
 
 #### Creating MultiURL client
+
 ```java
 import io.odpf.stencil.config.StencilConfig;
 
@@ -61,7 +61,6 @@ urls.add("http://localhost:8082/v1beta1/...");
 StencilClient stencilClient = StencilClientFacorty.getClient(urls, StencilConfig.builder().build());
 ```
 
-
 #### With StatsD client for monitoring
 
 ```java
@@ -74,7 +73,9 @@ StencilClient stencilClient = StencilClientFactory.getClient(url, StencilConfig.
 ```
 
 #### With Schema Update Listener
+
 Whenever schema has changed this listener will be called.
+
 ```java
 import io.odpf.stencil.SchemaUpdateListener;
 
@@ -83,7 +84,9 @@ StencilClient stencilClient = StencilClientFactory.getClient(url, StencilConfig.
 ```
 
 #### With version based refresh strategy
+
 If url belongs to stencil server, client can choose to refresh schema data only if there is a new version available.
+
 ```java
 import io.odpf.stencil.cache.SchemaRefreshStrategy;
 
@@ -92,7 +95,9 @@ StencilClient stencilClient = StencilClientFactory.getClient(url, config);
 ```
 
 #### Passing custom headers
+
 While sending request to specified URL, client can be configured to pass headers as well.
+
 ```java
 import org.apache.http.Header;
 import org.apache.http.HttpHeaders;
@@ -127,6 +132,7 @@ DynamicMessage message = DynamicMessage.parseFrom(descriptor, bytes);
 ```
 
 #### Using Parser interface
+
 ```java
 import io.odpf.stencil.Parser;
 import com.google.protobuf.DynamicMessage;
diff --git a/clients/js/package.json b/clients/js/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@odpf/stencil",
-  "version": "0.1.7",
+  "version": "0.2.0",
   "description": "Stencil js client package provides a store to lookup protobuf descriptors and options to keep the protobuf descriptors upto date.",
   "main": "main.js",
   "scripts": {
diff --git a/cmd/root.go b/cmd/root.go
@@ -17,10 +17,8 @@ func New() *cobra.Command {
 		Example: heredoc.Doc(`
 			$ stencil namespace create
 			$ stencil schema create
-			$ stencil upload
-			$ stencil download
-			$ stencil snapshot list
 			$ stencil server start
+			$ stencil serve migrate
 		`),
 		Annotations: map[string]string{
 			"group:core": "true",
diff --git a/docs/static/img/banner.svg b/docs/static/img/banner.svg

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@odpf/stencil",`
`3`		`- "version": "0.1.7",`
	`3`	`+ "version": "0.2.0",`
`4`	`4`	`"description": "Stencil js client package provides a store to lookup protobuf descriptors and options to keep the protobuf descriptors upto date.",`
`5`	`5`	`"main": "main.js",`
`6`	`6`	`"scripts": {`