build: add scopp and rpm release (#141)

ravisuhag · web-flow · commit f25ecc853e38 · 2022-08-30T19:40:00.000-05:00
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -1,17 +1,13 @@
 project_name: stencil
-
 release:
-  draft: true
   prerelease: auto
-
 before:
   hooks:
     - go mod tidy
     - make clean
-
 builds:
-  - main: ./main.go
-    id: "stencil"
+  - id: "stencil"
+    main: ./main.go
     binary: stencil
     flags:
       - -a
@@ -23,7 +19,6 @@ builds:
     goarch: [amd64, 386, arm, arm64]
     env:
       - CGO_ENABLED=0
-
 archives:
   - replacements:
       darwin: macos
@@ -34,7 +29,6 @@ archives:
     format_overrides:
       - goos: windows
         format: zip
-
 changelog:
   use: "github-native"
   sort: asc
@@ -43,13 +37,10 @@ changelog:
       - "^docs:"
       - "^test:"
       - "^build:"
-
 checksum:
   name_template: "checksums.txt"
-
 snapshot:
   name_template: "{{ .Tag }}-next"
-
 dockers:
   - goos: linux
     goarch: amd64
@@ -60,7 +51,23 @@ dockers:
       - "docker.io/odpf/{{.ProjectName}}:latest"
       - "docker.io/odpf/{{.ProjectName}}:{{ .Version }}"
       - "docker.io/odpf/{{.ProjectName}}:{{ .Tag }}-amd64"
-
+nfpms:
+  - maintainer: ODPF
+    description: Schema registry
+    homepage: https://github.com/odpf/stencil
+    license: Apache 2.0
+    formats:
+      - deb
+      - rpm
+    replacements:
+      darwin: macOS
+scoop:
+  bucket:
+    owner: odpf
+    name: scoop-bucket
+  homepage: "https://github.com/odpf/stencil"
+  description: "Schema registry"
+  license: Apache 2.0
 brews:
   - name: stencil
     homepage: "https://github.com/odpf/stencil"
diff --git a/README.md b/README.md
@@ -38,17 +38,50 @@ Download the appropriate version for your platform from [releases](https://githu
 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
+#### MacOS
+
+`stencil` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/odpf/stencil/releases/latest) page:
 
 ```sh
-# Install stencil (requires homebrew installed)
-$ brew install odpf/tap/stencil
+brew install odpf/tap/stencil
+```
+
+To upgrade to the latest version:
+
+```
+brew upgrade stencil
+```
+
+#### Linux
+
+`stencil` is available as downloadable binaries from the [releases](https://github.com/odpf/stencil/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
+
+#### Windows
+
+`stencil` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/odpf/stencil/releases/latest) page:
+
+```
+scoop bucket add stencil https://github.com/odpf/scoop-bucket.git
+```
 
-# Upgrade stencil (requires homebrew installed)
-$ brew upgrade stencil
+To upgrade to the latest version:
 
-# Check for installed stencil version
-$ stencil version
+```
+scoop update stencil
+```
+
+#### Docker
+
+We provide ready to use Docker container images. To pull the latest image:
+
+```
+docker pull odpf/stencil:latest
+```
+
+To pull a specific version:
+
+```
+docker pull odpf/stencil:v0.2.2
 ```
 
 ## Usage
@@ -59,6 +92,8 @@ Stencil has three major components. Server, CLI and clients. Stencil server and
 
 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.
 
+Stencil server also provides a fully-featured GRPC and HTTP API to interact with Stencil server. Both APIs adheres to a set of standards that are rigidly followed. Please refer to [proton](https://github.com/odpf/proton/tree/main/odpf/stencil/v1beta1) for GRPC API definitions.
+
 **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.
@@ -96,7 +131,7 @@ $ make help
 $ make build
 
 # Init server config
-$ cp app/config.yaml config.yaml
+$ cp config/config.yaml config.yaml
 
 # Run database migrations
 $ ./stencil server migrate
@@ -124,7 +159,3 @@ 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.
 
 This project exists thanks to all the [contributors](https://github.com/odpf/stencil/graphs/contributors).
-
-## License
-
-Stencil is [Apache 2.0](LICENSE) licensed.
diff --git a/docs/docs/installation.md b/docs/docs/installation.md
@@ -3,29 +3,60 @@
 Stencil installation is simple. You can install Stencil on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. There are several approaches to installing Stencil.
 
 1. Using a [pre-compiled binary](#binary-cross-platform)
-2. Installing with [package manager](#homebrew)
-3. Installing from [source](#building-from-source)
-4. Installing with [Docker](#using-docker-image)
+2. Installing with [package manager](#MacOS)
+3. Installing with [Docker](#Docker)
+4. Installing from [source](#building-from-source)
 
 ### 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
+### MacOS
 
-You can install `stencil` on macOS or Linux using Homebrew:
+`stencil` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/odpf/stencil/releases/latest) page:
 
-```bash
-# Install stencil (requires homebrew installed)
-$ brew install odpf/taps/stencil
+```sh
+brew install odpf/tap/stencil
+```
 
-# Upgrade stencil (requires homebrew installed)
-$ brew upgrade stencil
+To upgrade to the latest version:
 
-# Check for installed stencil version
-$ stencil version
+```
+brew upgrade stencil
+```
+
+#### Linux
+
+`stencil` is available as downloadable binaries from the [releases](https://github.com/odpf/stencil/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
+
+### Windows
+
+`stencil` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/odpf/stencil/releases/latest) page:
+
+```
+scoop bucket add stencil https://github.com/odpf/scoop-bucket.git
+```
+
+To upgrade to the latest version:
+
+```
+scoop update stencil
+```
+
+### Docker
+
+We provide ready to use Docker container images. To pull the latest image:
+
+```
+docker pull odpf/stencil:latest
+```
+
+To pull a specific version:
+
+```
+docker pull odpf/stencil:v0.2.2
 ```
 
 ### Building from source
@@ -46,16 +77,6 @@ $ make build
 $ ./stencil version
 ```
 
-### Using Docker image
-
-Stencil ships a Docker image [odpf/stencil](https://hub.docker.com/r/odpf/stencil) that enables you to use `stencil` as part of your Docker workflow.
-
-For example, you can run `stencil help` with this command:
-
-```bash
-$ docker run odpf/stencil --help
-```
-
 ### Verifying the installation
 
 To verify Stencil is properly installed, run `stencil --help` on your system. You should see help output. If you are executing it from the command line, make sure it is on your `PATH` or you may get an error about Stencil not being found.
