From cadc0a83b63a1f7fa29e161f575fc9b6aec7cd54 Mon Sep 17 00:00:00 2001 From: Connor Hicks Date: Wed, 24 Mar 2021 20:43:36 -0400 Subject: [PATCH] updates to docs for new build behaviour --- docs/get-started.md | 9 +++++---- go.mod | 2 +- go.sum | 6 ++---- vendor/modules.txt | 2 +- 4 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/get-started.md b/docs/get-started.md index 33d902e1..cc3ec815 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -63,7 +63,7 @@ To build your Runnable into a Wasm module for Reactr or Atmo, use the build comm If the current working directory is a Runnable, subo will build it. If the current directory contains many runnables, subo will build them all. Any directory with a `.runnable.yaml` file is considered a Runnable and will be built. Building Runnables is not fully tested on Windows. ## Bundles -To build all of the Runnables in the current directory and bundle them all into a single `.wasm.zip` file, run `subo build . --bundle`. Atmo uses Runnable bundles to help you build powerful web services by composing Runnables declaratively. +By default, subo will write all of the Runnables in the current directory into a bundle. Atmo uses Runnable bundles to help you build powerful web services by composing Runnables declaratively. If you want to skip bundling, you can pass `--no-bundle` to `subo build` The resulting bundle can also be used with a Reactr instance by calling `h.HandleBundle({path/to/bundle})`. See the [Reactr Wasm instructions](https://github.com/suborbital/reactr/blob/master/docs/wasm.md) for details. @@ -73,9 +73,10 @@ Usage: subo build [dir] [flags] Flags: - --bundle if passed, bundle all resulting runnables into a deployable .wasm.zip bundle - -h, --help help for build - --native if passed, build runnables using native toolchain rather than Docker + --docker pass --docker to automatically build a Docker image based on your project's Dockerfile. It will be tagged with the 'identifier' and 'appVersion' from your Directive + -h, --help help for build + --native if passed, build runnables using native toolchain rather than Docker + --no-bundle if passed, a .wasm.zip bundle will not be generated ``` ## Building without Docker diff --git a/go.mod b/go.mod index 5713ccd3..9654d76a 100644 --- a/go.mod +++ b/go.mod @@ -5,7 +5,7 @@ go 1.16 require ( github.com/pkg/errors v0.9.1 github.com/spf13/cobra v1.1.3 - github.com/suborbital/atmo v0.1.1-0.20210325002519-b041bf57457e + github.com/suborbital/atmo v0.2.0 github.com/suborbital/reactr v0.9.1 golang.org/x/mod v0.4.2 gopkg.in/yaml.v2 v2.4.0 diff --git a/go.sum b/go.sum index 9e132376..584b16f9 100644 --- a/go.sum +++ b/go.sum @@ -182,10 +182,8 @@ github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5Cc github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/suborbital/atmo v0.1.1-0.20210313181308-bc6c9bd4aa04/go.mod h1:JY4mFIOLMi50+5dxTcjuDGcmyEjgnNX6cxKJfX0gWHY= github.com/suborbital/atmo v0.1.1-0.20210315231600-21e248dacd0f/go.mod h1:pUmfGo+TNrKO1r+LG4njMmrB+FHTyUsqB99Ow64xZ08= -github.com/suborbital/atmo v0.1.1-0.20210324125634-c5d4e9024770 h1:uYc6ZbdAymirKPf+GIjTMqjQeM6FSsXA7y7ARgvdHsc= -github.com/suborbital/atmo v0.1.1-0.20210324125634-c5d4e9024770/go.mod h1:40PRH9TeQ+9zd/8qULbjP56hiaW+dgQcunC6jwFGvuw= -github.com/suborbital/atmo v0.1.1-0.20210325002519-b041bf57457e h1:Ht/HB16ZJQ3dB9ddKY+MZkNdGaHKWctYvJNEln2O7n0= -github.com/suborbital/atmo v0.1.1-0.20210325002519-b041bf57457e/go.mod h1:40PRH9TeQ+9zd/8qULbjP56hiaW+dgQcunC6jwFGvuw= +github.com/suborbital/atmo v0.2.0 h1:OM1ZRAiISMa6UWxSOZ7+WcgXSmGP147u7vv8cITls+Q= +github.com/suborbital/atmo v0.2.0/go.mod h1:40PRH9TeQ+9zd/8qULbjP56hiaW+dgQcunC6jwFGvuw= github.com/suborbital/grav v0.3.0/go.mod h1:PapJ62PtT9dPmW37WaCD+UMhoZiNPp0N9E3nUfEujC4= github.com/suborbital/grav v0.3.2 h1:5k3zb5kHBI8/RbD4YA+QHmMo6oovRWASta9rrNIJEUg= github.com/suborbital/grav v0.3.2/go.mod h1:PapJ62PtT9dPmW37WaCD+UMhoZiNPp0N9E3nUfEujC4= diff --git a/vendor/modules.txt b/vendor/modules.txt index 7d5f8b6c..f8421c29 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -14,7 +14,7 @@ github.com/sethvargo/go-envconfig github.com/spf13/cobra # github.com/spf13/pflag v1.0.5 github.com/spf13/pflag -# github.com/suborbital/atmo v0.1.1-0.20210325002519-b041bf57457e +# github.com/suborbital/atmo v0.2.0 ## explicit github.com/suborbital/atmo/directive # github.com/suborbital/grav v0.3.2