All notable changes to Rover will be documented in this file.
This project adheres to Semantic Versioning.
-
Manage contract configuration - @sachindshinde, #1475 fixes #1421
Rover now includes two commands for creating, modifying, and reading contracts:
rover contract publish
androver contract describe
. Further documentation can be found here. -
Easier file output with new
--output
argument - @gocamille, #1413 fixes #1212The
--output
argument has long been used to configure the format of Rover's output. i.e.--output json
configures Rover to print its output as a JSON object. This argument has been renamed to--format
while maintaining backwards compatibility.--format json
should be used to configure the format of Rover's output, and the--output
argument allows you to specify a file to print the output to. Adding--output schema.graphql
to arover subgraph fetch
command will output your schema to a file.--output data.json --format json
will output the command data todata.json
.--output json
will still work by itself but will now print a warning, and--output [json|plain]
does not work with--format [json|plain]
. Further documentation can be found here. -
Adds
--router-config
torover dev
- @EverlastingBugstopper, #1446 fixes #1373, #1345, and #1468The new
--router-config
argument forrover dev
allows you to pass a router configuration file on startup that can configure settings such as header propagaion and CORS policies. Further documentation can be found here. -
Auto-update router versions in
rover dev
- @EverlastingBugstopper, #1432rover dev
will automatically use the version of the router specified in this plugin file instead of a hard coded version.
-
Better error and help text for ELv2 license argument - @DoumanAsh, #1456 fixes #1455
The help text for the
--elv2-license
argument now includes the expected value for the argument, in addition to the error message returned when the argument is needed but not passed. -
Updates the Ariadne template URL - @patrick91, #1439
-
Updates
./examples/supergraph-demo
to@apollo/server
v4, and removes./examples/dev
- @EverlastingBugsttopper, #1442 fixes #1440 and #1441 -
Updates dependencies - @EverlastingBugstopper, #1481, #1450
apollo-parser
0.3 -> 0.4base64
0.13 -> 0.21git2
0.15 -> 0.16graphql_client
0.11.0 -> 0.12serial_test
0.9 -> 1.0os_info
3.4 -> 3.5os_type
2.4 -> 2.6termcolor
1.1 -> 1.2tokio
1.21 -> 1.24
- Fixes a link to schema check example - @MayCXC, #1431
-
Replace the '--output' option type with '--format' - @gocamille, #1413 fixes #1212
This change adds the new option,
--format
, to allow users to define the format type for messages printed tostdout
(either by passingplain
orjson
as an argument to--format
). This replaces the use of--output
for defining format types. The--output
option will be available to define the output file type instead, following Command Line Interface Guidelines for file outputs. This is an additive, non-breaking change and using the--output
option will continue to be valid.
Important: 1 potentially breaking change below, indicated by ❗ BREAKING ❗
-
Fix implementation of
--header
argument - @EverlastingBugstopper, #1369 fixes #1365This change tightens up usage of the
--header
argument used forintrospect
commands by disallowing previously valid (but undocumented) usage like this:--header "Header-1: value" "Header-2: value"
. After this change, you must conform to what we have in the documentation, which indicates separate instances of the--header
argument for each header, like so:--header "Header-1: value" --header "Header-2: value"
.
-
Provide prebuilt binaries for ARM devices - @EverlastingBugstopper, #1356 fixes #582
As of this release,
rover.apollo.dev
delivers prebuilt binaries from our GitHub release for ARM devices. Most notably this means that Docker on M1 devices should work out of the box. You should be able to replace any custom builds in your tooling pipeline with a call to the official curl installer. -
Report downstream check task results - @sachindshinde, #1385
When running
rover subgraph check
commands, if the proposed schema would cause downstream failures (i.e. with contracts), those failures are now reported in the check response. -
Faster
rover supergraph compose
- @EverlastingBugstopper, #1392 fixes #992Rover now resolves all subgraph schemas in parallel when running
rover supergraph compose
on asupergraph.yaml
file. This should improve the speed to compose large supergraphs significantly. This change also drastically improves error handling by reporting all issues with resolving subgraph schemas (and informing you which schema(s) failed to resolve) rather than exiting on the first failed schema resolution. -
Add
--polling-interval
torover dev
- @patrick91, #1377 fixes #1221You can now set
--polling-interval
when runningrover dev
to change the frequency of introspection poll requests for subgraphs that don't provide the schema from the file system with the--schema
argument. -
Adds
--skip-update-check
to skip the once-per-day update check - @tsing, #1396 fixes #1394Once per day, Rover checks if there is a new version available for update and notifies the user if there is. There is now a flag you can pass to disable this check:
--skip-update-check
. -
Respect the
NO_COLOR
environment variable - @chnn, #1360rover
will not use color in any output when executed with theNO_COLOR
environment variable set totrue
.
-
Updates from clap v3 to clap v4 - @EverlatingBugstopper, #1404 fixes #1400
This release updated the command line argument parsing library to major version 4. There should be no noticeable compatibility issues with this update, only lighter binaries. The look and feel of the main
rover --help
output has changed to a neutral color palette along with this change. -
Updates Rust to 1.65.0 - @EverlastingBugstopper, #1399
-
Updates node.js to v18 - @renovate, #1389
-
Updates node dev-dependencies - @renovate, #1204 and zs#1398
-
Remove dependency on the
saucer
crate - @EverlastingBugstopper, #1402 -
Updates
introspector-gadget
to 0.2.0 - @EverlastingBugstopper, #1386 -
Only cache dependencies in CI, not whole
/target
- @EverlastingBugstopper, #1387 -
Use
engine@main
instead ofengine@current
to fetch the API schema - @EverlastingBugstopper, #1368 -
Use
lychee
as a link checker instead of npm - @ptondereau, #1328 fixes #1306We now use a Rust-based link checker to check the links in the Rover repository instead of a node-based link checker (that was much more flaky).
-
Describe latest federation versions in
./latest_plugin_versions.json
- @EverlastingBugstopper, #1363When you run
rover supergraph compose
, the latest version of composition is automatically downloaded to your machine, these latest version numbers are now stored in./latest_plugin_versions.json
in the Rover repo. -
Rename
apollo-
headers toapollographql-
headers - @jsegaran, #1411 -
Update npm to v9 - @renovate, #1412
-
Update studio algolia key to graphos - @trevorblades, #1384
-
Fix some broken links - @StephenBarlow, #1376
-
Fix a typo in the migration guide instructing the use of
check
instead ofpublish
- @EverlastingBugstopper, #1364 fixes #1361
-
Add templates for TypeScript, Go, Kotlin, and Java - @dbanty, #1347
The
rover template
commands now include four more languages.
-
Properly report errors when the first
rover dev
process starts up - @EverlastingBugstopper, #1342If something went wrong while starting the first
rover dev
process, it would attempt to start an attached process, which would fail with an inscrutablethe main rover dev session is no longer active
error message. Now, Rover properly reports issues with starting up the firstrover dev
session. -
Properly report plugin installation errors on
rover dev
startup - @EverlastingBugstopper, #1357If a plugin failed to install when starting
rover dev
, the error wouldn't be reported properly. Now, if something goes wrong, the error message will be printed properly. -
Replace some misleading error suggestions regarding ports with
rover dev
- @EverlastingBugstopper, #1340Some errors suggested retrying the
rover dev
command with a different--port
argument, which doesn't exist. In these cases,rover dev
will suggest that you specify a different--supergraph-port
argument instead. -
Don't exclude certain git remotes from
GitContext
- @EverlastingBugstopper, #1350 fixes #1349In v0.8.2, we started normalizing git remotes for anonymized telemetry. Unfortunately we started excluding git remotes that were not one of BitBucket, GitLab, or GitHub. We now record all of these properly.
-
Fix typo in
rover subgraph publish
output - @EverlastingBugstopper, #1358 fixes #1337Instead of saying "Monitor your schema delivery progresson studio",
rover subgraph publish
outputs "You can monitor this launch in Apollo Studio". -
Improve caching in CI - @EverlastingBugstopper, #1351 and #1352
In CI builds, we now cache
/target
and~/.cargo
, instead of just/target
. -
Specify all dependencies in root
Cargo.toml
- @EverlastingBugstopper, #1344All of Rover's dependencies can now be viewed and updated in the root
Cargo.toml
, rather than needing to hunt around the workspace to update crates. -
Updates dependencies - @EverlastingBugstopper, #1346
- assert_cmd 1 -> 2
- git2 0.14 -> 0.15
- online 3.0.1 -> 4.0.0
-
rover template
command suite - @dbanty, @michael-watson, @EverlastingBugstopper, #1287Two new commands have made their way to Rover:
rover template list
androver template use
. These commands provide a similar experience tocreate-react-app
, and allow you to extract GraphQL project templates to your local machine. Check out the docs for more on this new functionality. -
rover dev
to facilitate developing a supergraph on your local machine - @EverlastingBugstopper, #1190rover dev
allows you to join multiple running subgraph servers together into a local supergraph, providing the ability to run queries and inspect query plans with Apollo Sandbox. Check out the docs for more on this new functionality. -
If E013 is thrown and
$APOLLO_KEY
is set, give a more helpful suggestion - @ptondereau, #1284, #1285If Studio fails to recognize an API key and
APOLLO_KEY
is set, recommend unsetting the environment variable to use--profile default
instead.
- Remove useless stdout line for composition results - @ptondereau, #1124, #1291
-
Link directly to API Keys page in Studio - @abernix, #1202
The
rover config auth
command will now provide a link that takes you directly to the "API Keys" page where you can create a Personal API Key, rather than a page that requires you to click through to another page. -
Prefer "supergraph schema" terminology to "gateway" - @EverlastingBugstopper, #1239, #1332
rover subgraph publish
now refers to updating the "supergraph schema" as opposed to updating the "gateway," since supergraph schema consumers can be routers and/or gateways now.
- Fix a few typos in
ARCHITECTURE.md
- @dbanty, #1289
-
Check commands exit with failure when downstream tasks fail - @sachindshinde, #1280
Historically,
rover graph check
androver subgraph check
have aggregated errors for operation checks and/or composition checks. Checks are expanding in Studio and will continue to expand over time, starting with downstream contract checks forrover subgraph check
. When these tasks fail, Rover will throw an error and link to the checks page in Studio which will contiain more information on the exact failure. -
Detect improper VS Code API key pastes on Windows - @EverlastingBugstopper, #1026, 1268
We have added new error messages and recovery suggestions for malformed API keys caused by invalid copy+pastes in VS Code on Windows.
-
Adds
--watch
tointrospect
commands - @EverlastingBugstopper, #1207If you pass the
--watch
flag torover graph introspect
orrover subgraph introspect
, the GraphQL server will be introspected once every second, printing updates to the terminal as the introspection response changes. This could be used to bootstrap development workflows when combined with--output json
and a tool likejq
.
-
Trim double quotes in multilingual descriptions - @lrlna, #1245 fixes #1244 and #1114
rover graph introspect
no longer crashes if a field description contains cyrillic symbols. -
Fix link to ELv2 license information - @EverlastingBugstopper, #1262 fixes #1261
-
Link directly to API Keys page in Studio - @abernix, #1202
The
rover config auth
command will now provide a link that takes you directly to the "API Keys" page where you can create a Personal API Key, rather than a page that requires you to click through to another page. -
Skip Apollo Studio integration tests for fork PRs - @EverlastingBugstopper, #Issue #, 1216
Our CI pipeline skips Apollo Studio integration tests for forked repositories because they don't have access to the Apollo Studio organization that we use to run them.
-
Updates MacOS CI pipeline to use xcode 13.4 - @EverlastingBugstopper, #1211
-
Normalize git remote URLs for anonymized telemetry - @EverlastingBugstopper, #1279
-
Fixes superfluous output in npm installer - @EverlastingBugstopper, #1200 fixes #1197 and #1198
In 0.8.0, we released a fix for our npm installer that makes it compatible with yarn workspaces by reinstalling Rover if it doesn't exist. Unfortunately, that means that steps that rely on printing to stdout contained information about the installs in those invocations. This has been fixed.
- Adds documentation for the async checks feature introduced in 0.8.1 - @EverlastingBugstopper, #1193
-
Add new commands to use asynchronous checks API - @Y-Guo, #1139
If you want to kick off a check without waiting for it to complete you can provide the
--background
flag torover graph check
orrover subgraph check
. This will start the check in Apollo Studio. If your GitHub repo integrates with the Apollo Studio GitHub App, the check status will be updated on your GitHub branch. Using this flag can save you time and money with your CI provider. -
Improved error messages and logs for filesysten read/write - @EverlastingBugstopper, #1183
Start using the
saucer
create for file system read/writes. This will provide better errors than the ones provided bystd::fs
e.g.permission denied os error (2)
by providing context about which file rover is trying to read/write to. Every read/write/other filesystem operation will now be included in the--log info
output.
-
Install rover before run if missing in npm package - @trevor-schneer, #1184 fixes #1178
-
Don't retry
400 Bad Request
errors - @EverlastingBugstopper, #1166
-
Refactor command line argument parsing - @EverlastingBugstopper, #1155
-
Improve schema downloading for codegen, when building rover - @EverlastingBugstopper, #1166
-
Update rover to clap v3 - @EverlastingBugstopper, #1170 fixes #1165
-
Add Apollo Studio integration tests - @EverlastingBugstopper, #1188
We now run integration tests against Apollo Studio's platform API as part of our release pipeline.
-
Update help message for
rover subgraph introspect
- @EverlastingBugstopper, #1169Previously the help message for
rover subgraph introspect
claimed to introspect from Apollo Studio Registry but it really introspects from a running subgraph endpoint. -
Add Jenkins CI/CD Documentation - @StephenBarlow, #1151
-
Update, restructure, and add missing docs for existing rover commands - @StephenBarlow, #1154, #1157
-
Update rover version in CI/CD docs - @rajington, #1177
-
Fix broken anchors for fetching schema - @tchupp, #1176
-
Adds
readme fetch
andreadme publish
- @cy, #1128, #1141Adds support for fetching and publishing Apollo Studio graph variant READMEs with
rover readme publish
androver readme fetch
commands. Usage for these commands can be found by runningrover readme --help
and documentation can be found on our docs site.
-
Fix the endpoint
rover-client
uses to fetch Apollo Studio's GraphQL schema- @EverlastingBugstopper, 1126As of v0.6.0, Rover sends all Apollo Studio requests to the new public platform API. When this change was introduced, we changed where we issued our GraphQL requests, but did not update the build step that fetches the schema which could lead to mismatched types. This is now fixed, fields in the public platform API match codegen.
-
Fix typo in the environment variable
rover-client
uses to fetch Apollo Studio's GraphQL schema - @EverlastingBugstopper, #1125s/APOLLO_GPAPHQL_SCHEMA_URL/APOLLO_GRAPHQL_SCHEMA_URL
-
Schema checks are now free - @StephenBarlow, #1131
Update the documentation to remove references to schema checks being a paid feature, since they are now free!
-
Update ARCHITECTURE.md - @cy #1129
Update and clarify a few points in ARCHITECTURE.md.
Important: 1 breaking change below, indicated by ❗ BREAKING ❗
-
Use Apollo's Platform API - @pcarrier, #1074
Rover now uses Apollo's Platform API instead of the old Studio API. The breaking change is that the hostname is now
api.apollographql.com
where it used to begraphql.api.apollographql.com
, you may need to update your firewall rules. Other behavior should remain unchanged.
-
Fixes Input Value Definition block string encoding for descriptions. - @lrlna, #1116 fixes #1088
Input values are now multilined when a description is present to allow for a more readable generated SDL.
-
Removes upper bound on Node engines for npm installer - @EverlastingBugstopper, #1120 fixes #1119
Previously, Rover required that your node engine was between v14 and v17. We have removed the upper bound on this limit so you can now use Node 18 and any future versions.
-
Adds
cargo xtask docs
- @EverlastingBugstopper, #1118Developers of the Rover project can now run
cargo xtask docs
to spin up a local netlify server with your local docset. After running the command, you can navigate to http://localhost:8000/rover in your browser and changes you make to ./docs/source/**.md files will be updated automatically on save. -
Updates dependencies - @renovate-bot, #1117
node
16.14.2 -> 16.15.0npm
8.7.0 -> 8.8.0os_info
3.2 -> 3.3 -
Removes unused dependencies - @EverlastingBugstopper, #1113
-
Separate Studio client code from generalized GraphQL client code - @Geal, #1061
Introduces the
launchpad
workspace crate which contains operations not specific to Apollo Studio such as:- launching GraphQL queries using reqwest
- running an introspection query on a graph
- transforming a JSON SDL to a schema
-
Really fixes v0.5.2/v0.5.3 broken npm installs - @EverlastingBugstopper
It turns out that it's hard to test changes to npm installers without actually publishing to npm. In order to save burning another patch version I release v0.5.4-rc.0 to ensure that my changes would actually fix things.
- Fixes v0.5.2 broken npm installs - @EverlastingBugstopper, #1108
-
Default
rover supergraph compose
to Federation 2 if a@link
directive is found in a subgraph schema - @EverlastingBugstopper, #1097 fixes #1090When running
rover supergraph compose
, ifsupergraph.yaml
refers to a subgraph that contains an@link
directive and you haven't set thefederation_version
key, then Rover will use Federation 2 composition by default. -
Output Federation version information when running
rover supergraph compose
- @EverlastingBugstopper, #1102When running
rover supergraph compose
, Rover will print the Federation version number that it is using. You can access this version string programatically by running the command with the--output json
argument and accessing thefederation_version
field. -
Accept
-
as validsupergraph.yaml
to read config from stdin - @EverlastingBugstopper, #1092 fixes #525You can now run commands like
cat supergraph.yaml | rover supergraph compose --config -
much like you've always been able to do with the--schema
argument in other Rover commands.
- Hides
rover-fed2
fromrover --help
- @EverlastingBugstopper, #1091 fixes #1085
-
Address Rust 1.60.0 lints - @EverlastingBugstopper, #1098
-
Updates
binary-install
to v1.0.0 for the npm installer - @EverlastingBugstopper, #1099
-
Fixes some broken Federation 2 links - @StephenBarlow, #1084
-
Documents dynamic composition versions - @EverlastingBugstopper, #1087
-
Return a hard error in CI when the ELv2 license is not accepted instead of hanging for eternity - @EverlastingBugstopper, #1082 fixes #1081
If you ran
rover supergraph compose
withfederation_version: 2
in CI - it would prompt you to accept the ELv2 license and hang waiting for the input for eternity. This is no longer the case and you will get a helpful error message detailing exactly what you need to do to never see the error again. For more details on the license, see our FAQ. -
Removes extraneous debug statement - @EverlastingBugstopper, #1079
In my rush this morning I missed the removal of an
eprintln
statement. It's gone now.
Important: X breaking changes below, indicated by ❗ BREAKING ❗
-
rover-fed2
has been deprecated - @EverlastingBugstopper, #1058rover fed2 supergraph compose
has been deprecated. You should instead setfederation_version: 2
in yoursupergraph.yaml
to use Federation 2 with therover supergraph compose
command.
-
rover supergraph compose
optionally updates automatically - @EverlastingBugstopper, #1058 fixes #2046When running
rover supergraph compose
, Rover will automatically download the correct version of composition to use. In yoursupergraph.yaml
files, you can specifyfederation_version: 1
orfederation_version: 2
to always get the latest updates. You can pass the--skip-update
flag to skip checking for an update. You can also specify an exact version if you'd like to pin your federation version, like so:federation_version: =2.0.0
.Additionally, you can run
rover install --plugin supergraph@latest-2
orrover install --plugin [email protected]
to install a plugin ahead of time, which may be helpful in CI. For Federation 2, you'll have to accept the ELv2 license one time per machine. You likely want to setAPOLLO_ELV2_LICENSE=accept
in CI if you are using Federation 2. -
Adds
--insecure-unmask-key
torover config whoami
- @EverlastingBugstopper, #1043 fixes #1023Previously, running
rover config whoami
would output your entire API key to the terminal. This is not the documented behavior, and it is insecure because someone could be sharing their screen while trying to debug and accidentally leak their API key.Now,
rover config whoami
will mask your API key when it prints to the terminal. You can override this behavior by passing the--insecure-unmask-key
flag. -
Retry on timeouts and connection errors - @ptondereau, #1014 fixes #790
Rover will now automatically retry HTTP requests that fail due to timeouts or initial connection errors.
-
Define an HTTP agent for non-studio requests - @ptondereau, #1075 fixes #961
Rover now sends a User-Agent header along with all requests, not just requests to Apollo Studio.
-
Adds support for HTTP(S) proxies in npm installer - @farawaysouthwest, #1067 fixes #899
You can now install Rover from npm if you are behind a proxy.
- Fixed a dead link in ARCHITECTURE.md - @ptondereau, #1053
-
Simplify
rover subgraph fetch
query - @EverlastingBugstopper, #1056 fixes #992rover subgraph fetch
now uses a much more efficient query that only requests a single subgraph at a time rather than all of them. Yay GraphQL! -
Upgrades
apollo-encoder
- @bnjjj, #1017 fixes #1010
-
Set up new docs infrastructure - @trevorblades, #1051, #1052
@trevorblades has done an awesome job setting up new docs for Apollo, including Rover! Check out the shiny new repo.
- Fix npm installer - @EverlastingBugstopper
Important: X breaking changes below, indicated by ❗ BREAKING ❗
-
rover-fed2
has been deprecated - @EverlastingBugstopper, #1058rover fed2 supergraph compose
has been deprecated. You should instead setfederation_version: 2
in yoursupergraph.yaml
to use Federation 2 with therover supergraph compose
command.
-
rover supergraph compose
optionally updates automatically - @EverlastingBugstopper, #1058 fixes #2046When running
rover supergraph compose
, Rover will automatically download the correct version of composition to use. When you first install Rover, it will automatically download the latest composition function for Federation 1 and Federation 2. In yoursupergraph.yaml
files, you can specifyfederation_version: 1
orfederation_version: 2
to always get the latest updates. You can pass the--skip-update
flag to skip checking for an update. You can also specify an exact version if you'd like to pin your composition function, like so:federation_version: =2.0.0-preview.9
.Additionally, you can run
rover install --plugin supergraph@latest-2
orrover install --plugin [email protected]
to install a plugin ahead of time, which may be helpful in CI. -
Adds
--insecure-unmask-key
torover config whoami
- @EverlastingBugstopper, #1043 fixes #1023Previously, running
rover config whoami
would output your entire API key to the terminal. This is not the documented behavior, and it is insecure because someone could be sharing their screen while trying to debug and accidentally leak their API key.Now,
rover config whoami
will mask your API key when it prints to the terminal. You can override this behavior by passing the--insecure-unmask-key
flag. -
Retry on timeouts and connection errors - @ptondereau, #1014 fixes #790
Rover will now automatically retry HTTP requests that fail due to timeouts or initial connection errors.
- Fixed a dead link in ARCHITECTURE.md - @ptondereau, #1053
-
Simplify
rover subgraph fetch
query - @EverlastingBugstopper, #1056 fixes #992rover subgraph fetch
now uses a much more efficient query that only requests a single subgraph at a time rather than all of them. Yay GraphQL! -
Upgrades
apollo-encoder
- @bnjjj, #1017 fixes #1010
-
Set up new docs infrastructure - @trevorblades, #1051, #1052
@trevorblades has done an awesome job setting up new docs for Apollo, including Rover! Check out the shiny new repo.
-
Properly pin harmonizer versions - @EverlastingBugstopper, #1039
0.4.7 accidentally released [email protected] instead of preview.7 because of semver. Versions are now pinned properly.
-
Bumps harmonizer to v2.0.0-preview.7 - @EverlastingBugstopper, #1037
rover fed2 supergraph compose
now uses rust:[email protected]
and js:@apollo/[email protected]
.
-
Bumps harmonizer to v2.0.0-preview.5 - @EverlastingBugstopper, #1033
rover fed2 supergraph compose
now uses rust:[email protected]
and js:@apollo/[email protected]
.
-
Fixes "output from
rover-fed2
was malformed" serialization errors - @EverlastingBugstopper, #1030Federation 2 was broken in 0.4.4, every
rover fed2 supergraph compose
command would return "output fromrover-fed2
was malformed" which was not helpful.rover fed2 supergraph compose
now uses[email protected]
/@apollo/[email protected]
under the hood and the data passed between rover and rover-fed2 is matched up properly. Happy federating!
-
Updates the version of the underlying composition packages - @EverlastingBugstopper, #1025
rover supergraph compose
now uses[email protected]
/@apollo/[email protected]
androver fed2 supergraph compose
now uses[email protected]
/@apollo/[email protected]
. -
Updates README badges - @EverlastingBugstopper, #1016
Replaced the
stability: experimental
badge with a badge showing Rover's total download count, and replaced the outdated GitHub workflow badge with the appropriate CircleCI badge.
-
Fix npm installer logic for detecting glibc compatibility - @EverlastingBugstopper, #1006 fixes #1004
Our npm installer had a dependency that updated to v2.0 which included some breaking changes. These changes made our npm installer always return false when checking if the operating system has an appropriate version of
glibc
installed (in order to download the version of Rover withsupergraph compose
functionality). We have now moved to the appropriate API and installs of v0.4.3 should work as expected.
-
Adds launch URL feedback to
rover subgraph publish
- @Y-Guo, #989If a
rover subgraph publish
invocation kicks off a launch, it will now output the URL associated with the launch so you can go right to it in Studio. -
Improve messaging for
rover subgraph check
- @david-castaneda, #980In the case where the API schema does not change after a
subgraph check
but the core schema was modified, you are now notified as such rather than being displayed a confusing "there were no changes detected" message.
-
Omit Float scalars from introspection result - @lrlna, #988 fixes #985
Since
Float
is a built-in GraphQL scalar type, it is no longer included in Rover's introspection results. -
Fix configuration error messages when there are no profiles - @EverlastingBugstopper, #995 fixes #783
Rover had a hard time detecting when there were no configured profiles, so it never actually emitted error
E020
. Now it does, and we also get some performance improvements by only parsing environment variables on startup rather than on every time they are needed. -
No longer panic when printing large output - @EverlastingBugstopper, #955 fixes #842
Migrate away from the
println
andeprintln
macros that can cause panics from time to time and instead use calm_io to gracefully handle output. -
Lowers the maximum required
glibc
version from 2.18 to 2.17 - @EverlastingBugstopper, #990 fixes #991We build Rover in Docker with the
centos:7
base image, which hasglibc
v2.17
installed. This means we can lower our installer requirements to 2.17, allowing folks on older machines like centos to install Rover. Thanks to @theJC for the report and help with testing! -
Removes unused
--profile
argument fromrover subgraph introspect
- @EverlastingBugstopper, #950 fixes #948
-
Use
apollo-encoder
inrover-client
- @lrlna, #939sdl-encoder
has been replaced with the officialapollo-encoder
from theapollo-rs
ecosystem. -
Add PR template - @EverlastingBugstopper, #488
Now folks who are kind enough to contribute pull requests to Rover's repository will have a helpful template to fill out.
-
Fix mechanism for building old versions of Rover - @EverlastingBugstopper, #973 fixes #967
If a build is executed via
cargo xtask dist --version vx.x.x
, it will now actually download the schema it needs from the GitHub release artifacts page in order to build for the exact types that were built at that tagged version. -
Allow Rover to be installed alongside Node.js v17 - @EverlastingBugstopper, #999 fixes #993
-
Run plugin tests and lints in xtask - @EverlastingBugstopper, #977 fixes #909
-
Adds new unused input type to check mutations - @EverlastingBugstopper, #969 fixes #967
Update the inputs to our check mutations to always send
null
for theexcludedOperationNames
field.
-
Add docs for
rover supergraph fetch
- @StephenBarlow, #971 fixes #952 -
Miscellaneous documentation polish - @StephenBarlow, #965, #963
- Track WSL as a separate operating system from Linux - @ptondereau, #921 fixes #511
-
Properly indent multiline field comments in introspection output - @lrlna, #919 fixes #884
-
Properly encode string values with single quotes instead of always using triple quotes - @lrlna, #930
-
Updates
rover supergraph compose
to use@apollo/[email protected]
- @EverlastingBugstopper, #929 fixes #924This adds support for users of v16 of the
graphql
library in addition to fixing a bug in directive merging logic. -
Expand valid node runtime range to >=14 <17 for npm installs - @EverlastingBugstopper #900 fixes #912
- Miscellaneous copy edits - @StephenBarlow, #923
-
Federation 2 Support - EverlastingBugstopper, pull/887
The alpha version of Federation 2 has been released!
In Rover, you can use the Federation 2 composition model by running
rover fed2 supergraph compose --config <supergraph.yaml>
after installing therover-fed2
binary.. You must installrover-fed2
before you can runrover fed2 supergraph compose
, and they must be the same version in order to be compatible with each other. -
Graph lifecycle management - EverlastingBugstopper, issue/722 pull/861
Rover now supports the
rover graph delete
command, which will delete all subgraphs in a federated variant, or delete the schema for a non-federated variant.There is also new documentation on how
rover graph publish
androver subgraph publish
create new variants.Additionally, you no longer need to pass
--convert
tosubgraph publish
when publishing a subgraph to a new variant, though you will still need it when converting a non-federated variant to a federated variant. -
Fetch the subgraph's
routing_url
from the graph registry if it isn't specified in asupergraph.yaml
file - EverlastingBugstopper, pull/873Now, whenever
routing_url
is not specified for a subgraph insupergraph.yaml
and the source is agraphref
(which fetches a subgraph from the graph registry), the composed supergraph will use the routing URL from the graph registry for that subgraph instead of an empty string.
-
Output enum descriptions in introspection results - lrlna, issue/878 pull/879
Now, any introspection result that contains descriptions for enums will include them in the output.
-
Output directive arguments in introspection results - lrlna, pull/858
Now, any introspection results that contain directive arguments will include them in the output.
-
Refactor HTTP client configuration - ptondereau, issue/844 pull/890
When Rover first introduced options to configure the HTTP client, there was a function that took configuration arguments, and returned a client. This has now been refactored to use a more idiomatic builder approach. Thanks @ptondereau!
-
Updates workspace to the 2021 Rust edition - EverlastingBugstopper, pull/886
-
Replace 'data graph' with 'graph' in all of the docs - trevorblades, pull/860
-
Add a missing backtick to
$PATH
in the CI install docs - EverlastingBugstopper, pull/874 -
Clarify the drawbacks of publishing introspection results to the graph registry - EverlastingBugstopper, pull/866
Important: 1 breaking change below, indicated by ❗ BREAKING ❗
-
rover supergraph compose
uses a newer composition function that is incompatible with older versions of@apollo/gateway
- EverlastingBugstopper, issue/801 pull/832The
rover supergraph compose
command produces a supergraph schema by using composition functions from the@apollo/federation
package. Because that library is still in pre-1.0 releases (as are Rover and Apollo Gateway), this update to Rover meansrover supergraph compose
will create a supergraph schema with new functionality. In turn, this requires that you update your@apollo/gateway
version to >= v0.39.x.
-
Adds options to bypass TLS validation - EverlastingBugstopper, issue/720 pull/837
In some configurations, often on internal networks, you might need Rover to communicate over encrypted channels (e.g., HTTPS) but avoid the more stringent digital certificate verifications that validate hostnames. You might even need to bypass the digital certificate validation entirely. This is generally not recommended and considered to be much less secure but for cases where it's necessary, but now there are two flags you can use to configure how Rover validates HTTPS requests:
-
The
--insecure-accept-invalid-hostnames
flag disables hostname validation. If hostname verification is not used, any valid certificate for any site is trusted for use from any other. This introduces a significant vulnerability to person-in-the-middle attacks. -
The
--insecure-accept-invalid-certs
flag disables certificate validation. If invalid certificates are trusted, any certificate for any site is trusted for use. This includes expired certificates. This introduces significant vulnerabilities, and should only be used as a last resort.
-
-
Adds option to increase rover's request timeout - EverlastingBugstopper, issue/792 pull/838
By default, Rover times out requests to the Apollo Studio API and your graph endpoints after 30 seconds. Now, if you're executing a command that might take longer than 30 seconds to process, you can increase this timeout with the
--client-timeout
option like so:rover subgraph check my-graph --validation-period 1m --client-timeout=60
-
Simplify error formatting - EverlastingBugstopper, pull/845
Now, Rover always indents the suggestion by 8 spaces instead of determining its length based on the length of the error descriptor, and the underlying cause of request errors will only be printed once.
-
Clarify
--output json
support in migration guide, and provide an examplejq
script - EverlastingBugstopper, issue/839 pull/840The Apollo CLI migration guide now mentions Rover's support for
--output json
, and our--output json
docs now link to an example bash script for converting a check response to markdown.
-
Properly swallow unparseable git remotes - EverlastingBugstopper, issue/670 pull/760
In v0.2.0, we fixed a crash that occurred for users with non-standard git remotes. While the crash itself no longer occurred, the crash report itself was still generated - this is no longer the case.
-
Move markdown link checker to
cargo xtask lint
- EverlastingBugstopper, issue/774 pull/778We now check for broken markdown links through
xtask
, meaning you can more accurately check if CI will pass locally. -
Migrate lints/tests from GitHub Actions to CircleCI - EverlastingBugstopper, issue/774 pull/781
-
Run tests on centos 7 and ensure the binary only depends on glibc <= 2.18 - EverlastingBugstopper, pull/800
-
Migrate release process from GitHub Actions to CircleCI - EverlastingBugstopper, issue/795 pull/808
-
Clarifies setting HEAD SHA for GitHub Actions - StephenBarlow, pull/763
Extended the section in the docs for configuring GitHub Actions to include instructions for properly configuring the git context.
-
Fix a typo in the docs - SaintMalik, pull/762
-
Stabilize and document structured output - EverlastingBugstopper & StephenBarlow, issue/741 & pull/750/pull/752
Rover now has an
--output
parameter on every command that allows you to format Rover's output as well-structured JSON. Documentation for this feature can be found here. -
Add an error message when an input schema is empty - EverlastingBugstopper, issue/724 pull/726
If the input to
--schema
was ever empty, you'd get some fairly strange and unexpected error messages. Now, if you supply an empty schema via the--schema
argument, you'll get an error message informing you as such. -
Retry HTTP requests that respond with 500-599 errors - EverlastingBugstopper, issue/693 pull/727
Now, by default, Rover will retry any requests that result in an internal server error for up to 10 seconds.
-
Fix description encodings for introspection results - lrlna, issue/728 pull/742
Rover will now print descriptions for fields and inputs with correct spacing between triple quotes.
-
Don't panic on git remotes without an apparent owner - EverlastingBugstopper, issue/670 pull/731
Most git remotes include an author and a repo name, but this isn't always the case. One of Rover's dependencies assumed this was always the case, and would panic if it wasn't the case. This broke workflows for people who had these types of git remotes, but it won't anymore!
-
Properly send validation period as part of checks configuration - EverlastingBugstopper, issue/737 pull/738
-
Use correct cargo target for xtask commands - EverlastingBugstopper, issue/582 pull/730
Any
cargo xtask
command that relies on cargo targets will now determine a correct default if building on a machine with a CPU architecture other thanx86_64
-
Add
cargo update
tocargo xtask prep
step - EverlastingBugstopper, issue/746 pull/747This change makes sure that our dependencies are automatically updated as part of our release process.
-
Further DRY StudioClient - EverlastingBugstopper, pull/753
This PR removed some small inconsistencies between HTTP requests made to Apollo Studio vs. those made for user introspection requests.
-
Use our GitHub bug report template for auto-generated panic reports - EverlastingBugstopper, issue/530 pull/732
-
Deploy Rover's docs at the root to account for main root-level redirect - trevorblades, pull/744
This is purely a change to how Rover's docs are rolled out, no user facing changes here.
-
Update GraphQL types to match new API Schema - EverlastingBugstopper, issue/696 pull/697
The Apollo Studio API introduced a change that made a field in the
subgraph publish
mutation nullable. This caused our codegen to fail and users started getting some cryptic error messages for failed publishes in older versions of Rover.This release handles these cases better and also introduces local tooling for building old versions of Rover with the API schemas that were in production at the time that version was published with
cargo xtask dist --release vx.x.x
.
-
Fix broken link to supergraph schemas - abernix, issue/687 pull/706
There was a broken link in our docs that now points to a set of definitions of supergraphs and subgraphs that lives in the docs for Federation.
-
Update GraphQL types to match new API Schema - EverlastingBugstopper, issue/696 pull/697
The Apollo Studio API introduced a change that made a field in the
subgraph publish
mutation nullable. This caused our codegen to fail and users started getting some cryptic error messages for failed publishes in older versions of Rover.This release handles these cases better and also introduces local tooling for building old versions of Rover with the API schemas that were in production at the time that version was published with
cargo xtask dist --release vx.x.x
.
-
Fix broken link to supergraph schemas - abernix, issue/687 pull/706
There was a broken link in our docs that now points to a set of definitions of supergraphs and subgraphs that lives in the docs for Federation.
-
Adds structured output to Rover - EverlastingBugstopper, issue/285 pull/676
Rover now has an
--output
parameter on every command that allows you to format Rover's output as well-structured JSON. This structure is not set in stone and will change prior to a stable release. If you write scripts around this structured output, then you should add a check in your scripts for the top leveljson_version
key, and make sure to update your scripts when that version is not what you expect (the first version is1.beta
).We'd love your feedback on this new feature, or if you notice any bugs in your existing workflows, so please submit issues!
-
Updates
@tag
/@inaccessible
composition algorithm inrover supergraph compose
- trevor-scheer/EverlastingBugstopper, issue/682 pull/684- Includes simple merging/union rollup of
@tag
directives from subgraphs into a supergraph - Allows usage of
@tag
directives on all subgraph fields - Merges subgraph
@tag
directives into a supergraph- if ANY instance is tagged, the
@tag
is union merged into the supergraph
- if ANY instance is tagged, the
- Includes simple merging/union rollup of
-
rover subgraph publish
androver subgraph delete
now acknowledges operations with no composition errors. - EverlastingBugstopper, issue/632 pull/685Previously, if there were no composition errors on deletions/publishes of subgraphs, Rover would simply not display errors. Now, Rover will output a success message if there were no composition errors. This should make these types of successes more clear in CI workflows that may be publishing more than one subgraph at a time.
-
Make the test process fail in CI if there are test failures - EverlastingBugstopper, pull/683
For some reason,
cargo test
was exiting with code0
even if there were failed tests. We run tests through our own customxtask
, so we've added a wrapper aroundcargo test
to detect and propagate the problems with our tests in our CI logs. -
Updates dependencies - EverlastingBugstopper/dependabot, pull/671, pull/672, pull/673, and pull/680
anyhow
1.0.41
->1.0.42
cc
1.0.68
->1.0.69
cargo_metadata
0.13.1
->0.14.0
termimad
0.13.0
->0.14.0
-
Adds preview support for
@tag
and@inaccessible
directives - EverlastingBugstopper, pull/631Preview support for composing subgraphs with
@tag
and/or@inaccessible
core features usingrover supergraph compose
. Note that@apollo/gateway >= 0.33
is required when using preview support for these core features. -
Auto-decode gzipped responses - EverlastingBugstopper, pull/650
If your GraphQL server responds with an introspection response compressed with brotli, it will now be decoded automatically instead of failing the command.
-
Use built-in root certificates and re-use HTTP connection pool - EverlastingBugstopper, issue/645 pull/649
Rover now uses local CA Certificates along with your operating system's native TLS implementation instead of the Rust-based WebPKI implementation.
-
Re-use HTTP connection pool - EverlastingBugstopper, pull/650
Rover will now create and reuse the same HTTP connection pool for subsequent requests, which should slightly improve performance.
-
Removes unused dependencies - EverlastingBugstopper, pull/651
-
Auto-decode gzipped responses - EverlastingBugstopper, issue/608 pull/620
If your GraphQL server responds with a gzipped introspection response, it will now be decoded automatically instead of failing the command.
-
Prevent update checker from aborting commands - EverlastingBugstopper, pull/624
Previously, if there was a spurious network error when attempting to check for a newer version of Rover, the command would fail. This is no longer the case, if GitHub is down, you will still be able to run Rover commands.
-
Address Clippy 0.1.53 warnings - EverlastingBugstopper, pull/621
Updated Rover's code to conform to the latest lints.
-
New
cargo xtask
command suite - EverlastingBugstopper, issue/388 pull/562We've replaced a decent chunk of bash scripting in GitHub actions with Rust code. This means you can locally run most commands you need for contributing to Rover with
cargo xtask
. -
Additional integration tests - EverlastingBugstopper, pull/629
We've set up some integration tests that run
make ci
after cloning the supergraph-demo.
-
Extend contribution guide and create an architecture document - EverlastingBugstopper, JakeDawkins & StephenBarlow, issue/561 pull/594
Our new architecture document includes a guide on how to add a new command to Rover, and the
CONTRIBUTING.md
file at the root of the Rover repository is automatically included on our documentation site. -
Use rover@latest in BitBucket documentation - setchy, pull/617
-
Small clarifications/tweaks - StephenBarlow, pull/619
-
Fix panic on empty GraphQL Error array - EverlastingBugstopper, issue/590 pull/592
In certain scenarios, Rover will encounter GraphQL errors, which are return as an array of strings. Previously, we were not checking if that array was empty before attempting to print the first error in the array, which caused Rover to panic. Rover has now been refactored a bit to have simpler GraphQL error handling and will no longer panic in this scenario.
-
Don't mangle
stderr
when an update to Rover is available - EverlastingBugstopper, issue/584 pull/586Once a day, when a new version of Rover is available, it messages users letting them know that they can update. Unfortunately, this message was being printed to
stdout
instead ofstderr
due to a bug in an upstream dependency. This bug has now been fixed, and update messages are now properly routed tostderr
.
-
Update Error Code docs title - StephenBarlow, pull/597
"Index of Errors" -> "Rover CLI error codes"
-
Bump docs theme - StephenBarlow, pull/596
Updates Gatsby and Apollo's Gatsby theme to match the rest of Apollo's docs.
-
Correct instance of
subgraph push
- DNature, pull/585Fixes an instance of
subgraph push
to besubgraph publish
.
-
Vendor [email protected] - EverlastingBugstopper, issue/579 pull/580
Version 0.1.3 of Rover attempted to vendor OpenSSL as part of its build process, but MacOS comes preinstalled with LibreSSL instead of OpenSSL. Unfortunately, LibreSSL does not work with Rosetta 2, which allows M1 Mac users to emulate x86_64 code on their machines. Installing and specifying the correct OpenSSL version solves this problem.
-
Don't squash request errors - EverlastingBugstopper, issue/539 & issue/573, pull/574
Rover previously had error handling for using
subgraph introspect
on anapollo-server
instance with introspection disabled, but another attempt to handle HTTP Status Codes as errors superseded that specialized error. This case now has a much more helpful error message.
-
Remove OpenSSL runtime dependency - EverlastingBugstopper, issue/554 & issue/563, pull/558
Attempts to install Rover on M1 Macs were failing due to issues with OpenSSL. Issues with OpenSSL are incredibly common when writing and distributing cross-platform software, so we've attempted to remedy this issue by embedding (or vendoring) the necessary OpenSSL code directly into Rover's binaries.
-
Remove misfired E005 error - EverlastingBugstopper, issue/570 pull/571
-
Fix unusable
rover subgraph check
- EverlastingBugstopper, issue/553 pull/555Rover v0.1.1 had a regression that didn't allow
rover subgraph check
to be run on federated graphs due to a logic error. Thanks to @setchy for reporting this so quickly!.
-
Prebuilt binaries for Alpine Linux - EverlastingBugstopper, issue/537 pull/538
Previously, Rover was only built for systems that had
glibc
>= 2.18 installed. This was due to the fact that we embed v8 into the binaries to execute the JS-poweredrover supergraph compose
command.Our CI pipeline now produces a statically-linked binary compiled with
musl-libc
that does not includerover supergraph compose
. Our installers will check if you have a compatible version ofglibc
, and if you do not, it will download the new statically linked binary and warn you that it is missing some functionality.We hope to bring
rover supergraph compose
to Alpine in the future, though how soon that future will come is not yet known.
-
No longer panic on mistyped graph names/invalid API keys - EverlastingBugstopper, issue/548 & issue/550 pull/549
We received some user reports of Rover crashing if a graph name or API key was invalid. In these cases, you will now receive an actionable error message.
Important: 2 breaking changes below, indicated by ❗ BREAKING ❗
-
Removes -V/--version flag from subcommands - EverlastingBugstopper, pull/487
Rover's subcommands will always be the same version as Rover, so we no longer accept
-V
or--version
on Rover's subcommands. -
Disallow all non-UTF-8 argument values - EverlastingBugstopper, pull/487
Rover will no longer accept any argument values that cannot be properly interpreted as UTF-8.
-
rover supergraph fetch
- EverlastingBugstopper, issue/452 pull/485This new command allows you to fetch the latest successfully composed supergraph SDL. This can be used to bootstrap a local graph router, or to inspect the schema that is used in managed federation.
-
Adds link to the Apollo CLI -> Rover migration guide in
rover docs open
- EverlastingBugstopper, pull/492 -
rover supergraph compose
allows for registry and introspection SDL sources - lrlna, issue/449 pull/519Pulls subgraphs from various sources specified in the YAML config file. A valid config can now specify schema using Apollo Registry refs (
subgraph
,graphref
), local file references (file
) and subgraph introspection (subgraph_url
):subgraphs: films: routing_url: https://films.example.com schema: file: ./films.graphql people: routing_url: https://example.com/people schema: subgraph_url: https://example.com/people actors: routing_url: https://localhost:4005 schema: graphref: mygraph@current subgraph: actors
-
--routing-url
is now an optional argument torover subgraph publish
- EverlastingBugstopper, issue/169 pull/484When publishing a subgraph, it is important to include a routing URL for that subgraph, so your graph router knows where to route requests for types in a subgraph. Previously, you had to specify this argument on every
rover subgraph publish
, but now it acts as an upsert, meaning you must include it on your firstrover subgraph publish
, but subsequent publishes will retain the existing routing URL for a subgraph if--routing-url
is not specified. -
rover explain
command added - JakeDawkins, pull/457When encountering most errors in Rover, there will be an error code in the format
E###
printed along with the error description. Runningrover explain CODE
will now print a more detailed description of the error along with any resolution steps and relevant docs links. -
Better error messages for HTTP errors - EverlastingBugstopper, issue/489 pull/518
Previously, Rover obfuscated the information about HTTP errors that occurred. Now, if something goes wrong between your machine and any HTTP server, you'll get some more information about what exactly went wrong.
-
Add help text to
--log
argument - EverlastingBugstopper, pull/486 -
Updated descriptor formatting - lrlna, pull/533
We've added some bold and extra newline spacing to the human-readable descriptors for Rover's output.
-
Trim down log verbosity - EverlastingBugstopper, pull/532
-
Display "unspecified" in
rover subgraph list
output instead of "N/A" - abernix, issue/483 pull/505 -
Adds
rover docs open migration
- EverlastingBugstopper, pull/503There is a new migration guide from the old Apollo CLI to Rover, and this command will open that page for you.
-
Ignore routing URL argument in telemetry - EverlastingBugstopper, pull/506
-
Print output to file without additional newline - JakeDawkins, issue/469 pull/475
-
Removes unnecessary custom URL parser - EverlastingBugstopper, pull/493
structopt
will automatically use theFromStr
implementation on theUrl
type, so we have removed the custom parser we were previously using. -
Check for broken markdown links in CI - EverlastingBugstopper, issue/444 pull/460
Occasionally links get out of date (or they were mistyped in the first place) - we want to make sure links in this repository remain functional, so we now check for broken markdown links in our CI jobs that run on each push.
-
Addresses clippy 1.52 warnings - EverlastingBugstopper, pull/515
-
Fix credential retrieval in
rover config whoami
- EverlastingBugstopper, issue/514 pull/516rover config whoami
no longer fails if$APOLLO_KEY
is set but there is no default authentication profile. -
Point users towards issue templates instead of blank new issue page - EverlastingBugstopper, pull/509
-
Remove public preview section from docs - StephenBarlow, pull/527
Rover is now generally available!
-
Document using Rover with BitBucket Pipelines - setchy, pull/491
-
Remove incorrect note about subgraph schemas - JakeDawkins, pull/481
-
Remove automated steps from release checklist - EverlastingBugstopper, pull/473
Quite a few of the steps in our release checklist have been automated as a part of our CI strategy, so those steps have been removed from the manual checklist.
-
GitHub Releases page now explain how to validate the autogenerated SHA-256 checksums. - EverlastingBugstopper, pull/445
-
Update demo introspection endpoint from https to http - abernix, pull/534
-
Document Rover's inability to run on Alpine images - lrlna, issue/524 pull/528
-
Change "Discuss on Spectrum" link to go to Spectrum's root - abernix, issue/492 pull/507
-
Prints information about opting out of anonymized usage data collection after installation - EverlastingBugstopper, pull/456
-
Report SHA-256 hash of git remote URL - EverlastingBugstopper, issue/313 pull/461
Our anonymized usage data will now report the hash of a git remote URL if it exists to more accurately determine the number of unique projects Rover is used in.
-
Client returns an error on non-200 status codes - EverlastingBugstopper, pull/472
Sometimes when performing HTTP requests, a non-200 status code is returned. This is now properly handled, and Rover's HTTP client will return a proper error message informing you of the bad response.
-
Curl installer returns error message on Linux if glibc is missing - EverlastingBugstopper, issue/393 pull/494
Rover is currently built for the
unknown-linux-gnu
rustc target, which requiresglibc
>= 2.7 to be installed. Previously, if you attempted to install Rover on a machine withoutglibc
, you would get quite cryptic linker errors. Now, users attempting to install Rover without the properglibc
install will get an error message informing them. -
Better error messages when running
rover subgraph
commands on non-federated graphs - JakeDawkins & lrlna, issue/121 pull/459You will now receive error messages for attempting to introspect a subgraph on graphs that don't support
_service
, attempting to push a subgraph to a non-federated graph, and for attempts to runrover subgraph check
on a non-federated graph.
-
Adds a newline to all output to stdout - EverlastingBugstopper, issue/458 pull/462
Rover no longer has the bug where it wouldn't conclude its output with a newline. Now we don't make your shells upset!
-
Automatically add triage labels to issues created with templates - JakeDawkins, pull/448
-
Refactor API key loading - EverlastingBugstopper, pull/463
Made a slight performance refactor to how we load our API keys that reduces the number of filesystem reads.
-
Update dependency crates - EverlastingBugstopper, pull/470
- Updates language of migration guide - StephenBarlow, pull/446
This release is a small release to fix the automated release process, and should be considered an extension of the previous (v0.0.8) release
-
** Fix boolean logic in release action - EverlastingBugstopper, pull/442**
0.0.8 was released to npm as a beta by accident because of an environment variable being treated as a boolean when it's a string. This just fixes that for a new release.
-
Users can now install Rover with a shorter URL - JakeDawkins, issue/287 pull/426
Instead of downloading Rover's install script from the tagged GitHub URL, you can now use the much simpler endpoints:
https://rover.apollo.dev/nix/latest and https://rover.apollo.dev/win/latest.
You can see our documentation for more info on the new installation pattern.
-
Print link to documentation after installation - EverlastingBugstopper, issue/141 pull/437
After a user installs Rover, we now print a link to the getting started page at https://go.apollo.dev/r/docs.
-
Deserialize supergraph configuration to a deterministic data structure - lrlna, issue/422 pull/423
Previously, when Rover deserialized a supergraph configuration file, it did so using a HashMap. This made the results of
rover supergraph compose
non-deterministic, which was undesirable. By switching from a HashMap to a BTreeMap,rover supergraph compose
is now deterministic.
-
Update telemetry URL - JakeDawkins, pull/427
Telemetry is now routed through a Netlify function instead of a Cloudflare Worker.
-
Add Apollo CLI to Rover migration guide - JakeDawkins, issue/284 pull/425
Rover now has a migration guide for users coming from the Apollo CLI. You can see it here.
-
Added specificity to Rover's public preview period docs - ndintenfass, pull/415
-
Small categorization update - StephenBarlow, pull/414
-
Add postinstall instructions - EverlastingBugstopper, pull/406
Adds a message after an install on how to add Rover to a user's PATH.
-
Change 'CSDL' to 'Core Schema' - lrlna, pull/403
Output of
rover supergraph compose
is a Core Schema. Our output previously indicated that it was aCSDL
. -
Remove Rover binary before overwriting it - EverlastingBugstopper, issue/398 pull/400
Updating Rover with
curl
required a restart on MacOS due to Apple's Gatekeeper not recognizing that a new package has been installed on a user's system. This forces the installer to remove previously Rover directory and its installation and do a fresh installation. -
Adds entitlements to MacOS signed binaries - EverlastingBugstopper, issue/399 pull/405
rover supergraph compose
process has been gettingkilled
on MacOS inv0.0.5
release. This was happening due to the fact that we are usingdeno-core
to execute composition, a package that requires access to memory management. This fix adds an Entitelement when notarizing Rover that specifically allows for unsigned packages to have access to memory management.
Important: 2 breaking changes below, indicated by ❗ BREAKING ❗
-
Adds introspection ability for subgraphs - lrlna, issue/349 pull/377
A new command,
rover subgraph introspect
has been added. This command runs a federated introspection query against a server which has implemented the requirements of the federation specification. This command accepts endpoint headers (-H
,--header
) for making the introspection request (if required) and outputs SDL to stdout. -
Fallback to monochromic output in installer when
tput
is unavailable - abernix, issue/371 pull/372The
tput
command allows easier ANSI output using named values in rather than control characters.While we could just use control characters and maintain colored output in the absence of
tput
, it's probably also reasonable to gracefully fall back to monochromatic output.
-
Renames
core build
tosupergraph compose
- lrlna, pull/391To align with other Apollo teams on the usage of
supergraph
andcomposition
, we are renamingcore build
tosupergraph compose
. -
Updates [email protected] - abernix, pull/396
Updates harmonizer to the latest version. This version now composes and returns a core schema instead of CSDL. CSDL was an internal implementation of composition and this new format is meant to bring some stability to
rover supergraph compose
.
-
Handle 400-599 HTTP responses - lrlna, issue/394 issue/187 pull/395
Previously, Rover did not provide errors for any HTTP requests that return a status code between 400 and 599. This fix makes sure Rover checks for those errors before moving on to parsing the response body.
This fix also does an extra check for 400 errors, as the Apollo Server sends additional information that we can display to users.
-
Sign and notarize MacOS binaries as part of CI - EverlastingBugstopper, pull/363
This automates our signing and notarization process when releasing MacOS binaries. This is especially necessary to install and run Rover on latest M1s and Big Sur.
-
Test, build and release on ubuntu-16.04 - abernix, pull/381
This pins us to Ubuntu 16.04 which ships with glib 2.19. This should allow us to work with a wider range of operating systems than the newer glib that we get with Ubuntu 20.04, which is ubuntu-latest on GitHub Actions Virtual Environments (which resulted in a Rover that wouldn't run on Ubuntu 18.04).
Ubuntu 16.04 is LTS until April 2024, and is still receiving active updates through the LTS program.
-
Cache Rust artifacts in CI linter job- EverlastingBugstopper, pull/365
The rest of our GitHub actions workflows pull from the cache to take advantage of Rust's incremental compilation. We now do this for clippy too so it finishes (and fails) faster.
-
Addresses new clippy 1.51 warning - EverlastingBugstopper, pull/364
Addresses some stylistic problems noticed by the new version of our linter clippy
-
Update documentation for 0.0.5 release- JakeDawkins StephenBarlow EverlastingBugstopper, pull/389
Documents recent additions to Rover in detail, including
rover supergraph compose
,rover subgraph introspect
androver graph introspect
.
Important: Two breaking changes below, indicated by ❗ BREAKING ❗
-
Core schema building capabilities - EverlastingBugstopper, pull/340
Adds a new command,
rover core build
to handle building core schema documents from multiple subgraph schemas. This also adds a new config format to support this command in YAML. Currently, this is only documented in pull/340. -
Adds introspection ability for graphs - lrlna, issue/180 issue/171 pull/283
A new command,
rover graph introspect
has been added, usable for introspecting graphs (not subgraphs). This command accepts endpoint headers for making the introspection request (if required) and outputs SDL to stdout.
-
Rename
push
topublish
everywhere - JakeDawkins, issue/344 pull/347"Publish" is a more correct name for what these commands do. We wanted to be extra clear about its name matching its functionality, so any usage of
push
commands should now bepublish
. -
Rename
committer
toauthor
- EverlastingBugstopper, issue/338 pull/339Note: This is only breaking change if you were previously using the
APOLLO_VCS_COMMITTER
env variable. If so, migrate by changing that environment variable toAPOLLO_VCS_AUTHOR
.Changes the underlying git context implementation to report the
author
of a commit rather than acommitter
. This is primarily intended to properly link the real author with a commit in Apollo Studio.
-
Output composition errors to stderr - EverlastingBugstopper, pull/335
There was an incorrect usage of
tracing::error
, causing composition errors to not show up when expected. This change unifies this error printing with the rest of the project.
-
Auto-bump versions in install scripts - EverlastingBugstopper, pull/332
Added auto version bumping in the build script, so there's no chance the Rover team will miss this important step in the release process.
-
Don't print by default for automatic update checks - EverlastingBugstopper, pull/342
When Rover automatically checks for updates every 24 hours, it no longer will print if there is no update available. It will still print for manual checks and if Rover is out of date.
-
Add metadata to
Cargo.toml
- EverlastingBugstopper, pull/346In preparation for future releases to crates.io, we've added relevant metadata to the Cargo.toml file for the project.
-
Adds
APOLLO_HOME
variable to docs - EverlastingBugstopper, pull/341APOLLO_HOME
is the override variable for Rover's parent directory, where the binary lives. This was previously undocumented, but now it's not!
-
❗ BREAKING ❗ Squash
config show
functionality intoconfig whoami
- EverlastingBugstopper, issue/274 pull/323Since the only thing that
rover config show
did was show the saved api key, it made sense to squash that functionality into thewhoami
command. We decided that we'd prefer not to ever expose the full api key to stdout (you can still find it in the saved config file), but we still show the first and last 4 characters of it to help with debugging. -
Add api key origin to
whoami
command - EverlastingBugstopper, issue/273 pull/307The
whoami
command, which is used to verify api keys and help with debugging now shows where that key came from, either a--profile
or theAPOLLO_KEY
env variable. -
rover docs
commands to make viewing documentation easier - EverlastingBugstopper, issue/308 pull/314To make it easier to find and navigate Rover's docs, we added two commands:
rover docs list
to list helpful docs pages androver docs open
to open a docs page in the browser. -
Better errors and suggestions for invalid variants - EverlastingBugstopper, issue/208 pull/316
Previously, Rover would tell you if you tried accessing an invalid variant, but couldn't provide any recommendations. This adds recommendations for simple typos, lists available variants for graphs with small numbers of variants, and provides a link to view variants in Apollo Studio for graphs with many variants.
-
Remove the need to reload terminal after install - EverlastingBugstopper, issue/212 pull/318
Rather than asking users to reload their terminal after install, we do the extra work of sourcing Rover's env file after install, preventing linux users from having to do that or reload the terminal themselves.
-
Rover automatically checks for updates - JakeDawkins, issue/296 pull/319
Every 24 hours, Rover will automatically check for new releases and let you know. You can also run the
rover update check
command to manually check for updates. If an update is available, Rover warns once per day at most and provides a link to the docs for update instructions. -
Update installers to be consistent and not require version variables - JakeDawkins, issue/88 pull/324
This provides a consistent experience when installing Rover. When running the linux install script, you no longer are required to pass a
VERSION
, but still may if you want to download an older version. The windows installer now supports the same$Env:VERSION
environment variable for similar overrides. By default, installer scripts will download the version of rover released with that version of the script. -
Verify paths are all valid utf-8 - EverlastingBugstopper, pull/326
Just to make our code more safe and easier to maintain, we now check and make sure paths are all valid utf-8 to make sure any non utf-8 paths won't cause unexpected issues.
- Consistently refer to configuration instead of config in error messages - EverlastingBugstopper, pull/306
-
Move all build-time checks for env variables to util - EverlastingBugstopper, pull/310
Having a bunch of
env!
macros across the codebase is just less beautiful and maintainable than having them in one utility file. This PR just moves all of those calls, looking upCARGO_ENV_*
environment variables to a single place. -
Make output tables prettier - EverlastingBugstopper, pull/315
Replaces the characters in table borders with characters that show fewer & smaller gaps to make tables look a little more polished :)
-
Add test to make sure install scripts never change names/paths - EverlastingBugstopper, pull/321
This adds a simple test to make sure we don't move or rename install scripts on accident in the future, since that would be a major breaking change.
-
Instructions for using Rover in CircleCI and GitHub Actions - JakeDawkins, issue/245 pull/329
Some CI providers require a couple of additional steps to get Rover installed and working. These docs help get Rover working with linux setups in GitHub Actions and CircleCI.
-
Better logging experience - EverlastingBugstopper, pull/263
When passing
--log debug
, the logs are now pretty printed with their call location.Additionally, progress messages are no longer printed with an
INFO
prefix on every line, messages are displayed to the user with no mess and no fuss. -
Add useful info to debug logs - EverlastingBugstopper, pull/268
When running Rover with
--log debug
, you can now see which environment variables are being used and the raw JSON payload returned by the Apollo Studio API. -
Provide a better error message for malformed API Keys - EverlastingBugstopper, issue/215 pull/275
Before, if you passed a malformed API key, the error message was "406: Not Acceptable", since that's what the Apollo Studio API returned. Rover now provides you with a much more actionable error message.
-
Add support for M1 Macbooks - EverlastingBugstopper, issue/295 pull/297/pull/300
Big Sur allows the new M1 Macbooks to run code compiled for the
x86_64
architecture in emulation mode, even though the machines themselves have anarm64
architecture. We have updated ourcurl | sh
installer and ournpm
installer to reflect this, and anybody running Big Sur on the new M1 machines can now install and use Rover. -
Add a
>
prompt to therover config auth
command - EverlastingBugstopper, issue/279 pull/281It was a bit confusing to be presented with a blank line after running
rover config auth
. To make it more clear that this is a prompt for an API key, we now print>
at the beginning of the prompt. -
Add a friendlier message for the case of no config profiles - JakeDawkins, issue/202 pull/303
The new user experience, where there are no config profiles found, was a little cryptic. To make it easier to understand what the problem is, we added a friendly error message asking the user to run
rover config auth
. -
Output Service title for graph keys in whoami command - lrlna, issue/280 pull/299
rover config whoami
was displayingName
information which was unclear in the context of this command. Instead ofName
, we are now displayingService title
information for graph keys, and omittingName
andService Title
for user keys, as the already existing information provides enough information forUser
.
-
Allow Rover to be used outside the context of a git repository - JakeDawkins, issue/271 pull/282
-
Always use the shorthand ref when generating Git Context - lrlna, pull/255
Rover now computes the shorthand ref and specifies that as the "branch", even if the specific ref is not necessarily a branch (such as a tag).
-
Do not send telemetry events for dev builds - EverlastingBugstopper, pull/258
-
Fix a typo in the README - abernix, pull/269
s/Rover co[ma]{3}nds to interact/Rover commands to interact/
-
Address latest style suggestions (clippy) - lrlna, pull/267
A new version of clippy gave us some pointers for more idiomatic code style, and we addressed them!
-
Unify terminal text color dependency - EverlastingBugstopper, pull/276
Now we only use
ansi_term
for providing colored text. -
Hide API key printing in debug logs - JakeDawkins, pull/302
We no longer print a user's api key in the
--log debug
logs when saving a key (fromrover config auth
)/
-
Document Git Context - JakeDawkins, pull/262
We added documentation for how Rover provides Git Context to Apollo Studio. You can read all about it here.
-
Fix npx usage documentation - abernix, pull/270
We updated the docs to show that it is necessary to pass
--package @apollo/rover
each time Rover is invoked throughnpx
. -
Update layout of Rover's intro article - StephenBarlow, pull/259
The intro article in Rover's docs were reordered to put the info about the Public preview towards the bottom of the page, so more relevant information is no longer below the fold.
Initial beta release. Please visit our documentation page for information on usage.