Tweak deployment examples

aantron · May 8, 2021 · 3885eb5 · 3885eb5
1 parent f36afcf
commit 3885eb5
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 17 deletions.
diff --git a/.github/workflows/heroku.yml b/.github/workflows/heroku.yml
@@ -1,16 +1,15 @@
 name: heroku
 on:
   push:
-    paths: 'example/z-heroku/**'
+    paths:
+    - 'example/z-heroku/**'
+    - .github/workflows/heroku.yml
 
 # Set this key on GitHub in your repository's Settings, tab Secrets. The key is
-# obtained by running
-#
-#   heroku authorizations:create
-#
-# locally, after doing
+# obtained by running locally
 #
 #   heroku login -i
+#   heroku authorizations:create
 env:
   HEROKU_API_KEY: ${{secrets.HEROKU_API_KEY}}
 

diff --git a/example/z-docker-esy/.dockerignore b/example/z-docker-esy/.dockerignore
@@ -1,10 +1,10 @@
-# Esy build environment
+# esy build environment
 _esy/
 
-# Esy dependencies
+# esy dependencies
 node_modules/
 
-# Git
+# git
 .git/
 .gitignore
 

diff --git a/example/z-docker-esy/README.md b/example/z-docker-esy/README.md
@@ -176,11 +176,13 @@ version of the deploy script.
 
 **See also:**
 
+- [**`z-docker-opam`**](../z-docker-opam#files) is a variant of this example
+  that uses opam instead of esy.
 - [**`z-systemd`**](../z-systemd#files) packages the app as a systemd daemon,
   outside of a Docker container.
 - [**`z-heroku`**](../z-heroku#files) deploys the app to
   [Heroku](https://heroku.com).
 
 <br>
 
-[Return to the example index](../#deploying)
+[Up to the example index](../#deploying)
diff --git a/example/z-docker-opam/.dockerignore b/example/z-docker-opam/.dockerignore
@@ -1,4 +1,4 @@
-# Opam local switch
+# opam local switch
 _opam/
 
 # Dune build environment

diff --git a/example/z-docker-opam/README.md b/example/z-docker-opam/README.md
@@ -20,4 +20,4 @@ there automatically, on push, by a
 
 <br>
 
-[Return to the example index](../#deploying)
+[Up to the example index](../#deploying)
diff --git a/example/z-heroku/README.md b/example/z-heroku/README.md
@@ -19,7 +19,7 @@ let () =
   Dream.run ~interface:"0.0.0.0" ~port:(int_of_string (Sys.getenv "PORT"))
   @@ Dream.logger
   @@ Dream.router [
-    Dream.get "/" (fun _ -> Dream.html "Good morning, world!");
+    Dream.get "/" (fun _ -> Dream.html "Dream running in Heroku!");
   ]
   @@ Dream.not_found
 ```
@@ -179,4 +179,13 @@ by Aleksandra Sikora.
 
 <br>
 
-[Return to the example index](../#deploying)
+**See also:**
+
+- [**`z-docker-esy`**](../z-docker-esy#files) deploys to a dedicated server,
+  with the Web application managed by Docker Compose.
+- [**`z-systemd`**](../z-systemd#files) deploys to a dedicated server, running
+  the Web application as a systemd daemon.
+
+<br>
+
+[Up to the example index](../#deploying)
diff --git a/example/z-heroku/app.ml b/example/z-heroku/app.ml
@@ -2,6 +2,6 @@ let () =
   Dream.run ~interface:"0.0.0.0" ~port:(int_of_string (Sys.getenv "PORT"))
   @@ Dream.logger
   @@ Dream.router [
-    Dream.get "/" (fun _ -> Dream.html "Good morning, world!");
+    Dream.get "/" (fun _ -> Dream.html "Dream running in Heroku!");
   ]
   @@ Dream.not_found
diff --git a/example/z-systemd/README.md b/example/z-systemd/README.md
@@ -37,7 +37,9 @@ let () =
   @@ Dream.not_found
 ```
 
-It is live at [http://systemd.dream.as](http://systemd.dream.as).
+It is live at [http://systemd.dream.as](http://systemd.dream.as). As a second
+example, the [playground](http://dream.as) is deployed as a [systemd
+service](https://github.com/aantron/dream/blob/master/example/z-playground/server/playground.service).
 
 The service can be hosted on any server provider. We will use [Digital
 Ocean](https://www.digitalocean.com) in this example. We will run the build
@@ -199,4 +201,4 @@ very convenient way of passing it to the action.
 
 <br>
 
-[Return to the example index](../#deploying)
+[Up to the example index](../#deploying)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -20,4 +20,4 @@ there automatically, on push, by a

		<br>

		[Return to the example index](../#deploying)
		[Up to the example index](../#deploying)