Merge pull request #1630 from scpwiki/features

Remove local / deploy features from deepwell

.github/workflows/deepwell.yaml

@@ -45,11 +45,11 @@ jobs:
       - name: System Dependencies
         run: sudo apt update && sudo apt install libmagic-dev
 
-      - name: Build (local)
-        run: cd deepwell && cargo build --features local
+      - name: Build (no features)
+        run: cd deepwell && cargo build --no-default-features
 
-      - name: Build (deploy)
-        run: cd deepwell && cargo build --features deploy
+      - name: Build (all features)
+        run: cd deepwell && cargo build --all-features
 
       - name: Check Configuration
         run: cd deepwell && cargo run -- config.example.toml ../install/files/local/deepwell.toml

deepwell/Cargo.toml

@@ -13,8 +13,6 @@ authors = ["Emmie Maeda <[email protected]>"]
 edition = "2021" # this is *not* the same as the current year
 
 [features]
-local = ["watch"]
-deploy = []
 watch = ["notify"]
 
 [dependencies]

deepwell/README.md

@@ -54,22 +54,11 @@ The routes are defined in `api/`, with their implementations in `methods/`, and
 
 This executable targets the latest stable Rust. At time of writing, that is `1.72.0`.
 
-There are two features supported by DEEPWELL, along with what they add:
-
-* `local` — Intended for local development, where frequent compilation is likely.
- * Tracks the locale directory and configuration file, reloading them if they are modified.
-* `deploy` — Intended for "deployed" environments, i.e. `dev` and `prod`.
-
-Thus for a _release build_ (being deployed somewhere) you would want to run:
-
-```sh
-$ cargo build --release --features deploy
-```
-
-And for a _local build_ you would want:
+At present the crate has one feature:
+* `notify` — Enables a feature to track the locale directory and configuration file, reloading the server if they are modified. This should be used in local builds only, not in production.
 
 ```sh
-$ cargo build --features local
+$ cargo build [--features ...] [--release]
 ```
 
 ### Execution

install/aws/dev/docker/api/Dockerfile

@@ -17,7 +17,7 @@ WORKDIR /src/deepwell
 RUN cargo vendor
 
 # Build deepwell server
-RUN cargo build --release --features deploy
+RUN cargo build --release
 
 #
 # Final image

install/aws/prod/docker/api/Dockerfile

@@ -17,7 +17,7 @@ WORKDIR /src/deepwell
 RUN cargo vendor
 
 # Build deepwell server
-RUN cargo build --release --features deploy
+RUN cargo build --release
 
 #
 # Final image

install/local/dev/api/Dockerfile

@@ -26,4 +26,4 @@ RUN mkdir /src
 COPY ./deepwell /src/deepwell
 WORKDIR /src/deepwell
 
-CMD ["/usr/local/cargo/bin/cargo", "watch", "-w", "/src/deepwell", "-w", "/opt/locales", "-w", "/etc/deepwell.toml", "--why", "-x", "run --features local -- /etc/deepwell.toml"]
+CMD ["/usr/local/cargo/bin/cargo", "watch", "-w", "/src/deepwell", "-w", "/opt/locales", "-w", "/etc/deepwell.toml", "--why", "-x", "run -- /etc/deepwell.toml"]