diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 6562683868..66b203c412 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -40,14 +40,7 @@ Use `cargo build --all-targets` to build the project. Some tests run against the existing Node.js implementation of the Apollo Router. This requires that the `federation-demo` project is running. -First, initialize and update required git submodules. - -``` -git submodule init -git submodule update -``` - -Then, start the service: +Start the service: ``` docker-compose up -d diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md index 5341c6f46f..99bbeee91b 100644 --- a/NEXT_CHANGELOG.md +++ b/NEXT_CHANGELOG.md @@ -28,13 +28,13 @@ By [@USERNAME](https://github.com/USERNAME) in https://github.com/apollographql/ ## ❗ BREAKING ❗ ## 🚀 Features -### Add support for dhat based heap profiling [PR #1829](https://github.com/apollographql/router/pull/1829)) +### Add support for dhat based heap profiling ([PR #1829](https://github.com/apollographql/router/pull/1829)) [dhat-rs](https://github.com/nnethercote/dhat-rs) provides [DHAT](https://www.valgrind.org/docs/manual/dh-manual.html) style heap profiling. We have added two compile features, dhat-heap and dhat-ad-hoc, which leverage this ability. By [@garypen](https://github.com/garypen) in https://github.com/apollographql/router/pull/1829 -### Add `trace_id` in logs to identify all logs related to a specific request [Issue #1981](https://github.com/apollographql/router/issues/1981)) +### Add `trace_id` in logs to identify all logs related to a specific request ([Issue #1981](https://github.com/apollographql/router/issues/1981)) It automatically adds a `trace_id` on logs to identify which log is related to a specific request. Also adds `apollo_trace_id` in response headers to help the client to identify logs for this request. @@ -54,7 +54,7 @@ Example of logs in JSON: By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/1982 -### Reload the configuration when receiving the SIGHUP signal [Issue #35](https://github.com/apollographql/router/issues/35)) +### Reload the configuration when receiving the SIGHUP signal ([Issue #35](https://github.com/apollographql/router/issues/35)) This adds support for reloading configuration when receiving the SIGHUP signal. This only works on unix-like platforms, and only with the configuration file. @@ -63,7 +63,7 @@ By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/p ## 🐛 Fixes -### Fix the deduplication logic in deduplication caching [Issue #1984](https://github.com/apollographql/router/issues/1984)) +### Fix the deduplication logic in deduplication caching ([Issue #1984](https://github.com/apollographql/router/issues/1984)) Under load, it is possible to break the router deduplication logic and leave orphaned entries in the waiter map. This fixes the logic to prevent this from occurring. @@ -77,7 +77,7 @@ The Uplink API returns actionable info in its responses: By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/pull/2001 -### Fix the rhai SDL print function [Issue #2005](https://github.com/apollographql/router/issues/2005)) +### Fix the rhai SDL print function ([Issue #2005](https://github.com/apollographql/router/issues/2005)) A recent change to the way we provide the SDL to plugins broke the rhai SDL print. This fixes it. @@ -95,16 +95,23 @@ By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/p ## 🛠 Maintenance -### Apply tower best practice to inner service cloning [PR #2030](https://github.com/apollographql/router/pull/2030)) +### Apply tower best practice to inner service cloning ([PR #2030](https://github.com/apollographql/router/pull/2030)) Our service readiness checking can be improved by following tower project recommendations for cloning inner services. By [@garypen](https://github.com/garypen) in https://github.com/apollographql/router/pull/2030 -### Split the configuration file management in multiple modules [Issue #1790](https://github.com/apollographql/router/issues/1790)) +### Split the configuration file management in multiple modules ([Issue #1790](https://github.com/apollographql/router/issues/1790)) The file is becoming large and hard to modify. By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/pull/1996 ## 📚 Documentation + +### Remove references to git submodules from DEVELOPMENT.md ([Issue #2012](https://github.com/apollographql/router/issues/2012)) + +We don't need instructions about submodules since #1856. Let's remove them. + +By [@garypen](https://github.com/garypen) in https://github.com/apollographql/router/pull/2045 +