Skip to content

Latest commit

 

History

History
1514 lines (958 loc) · 69.4 KB

CHANGELOG.md

File metadata and controls

1514 lines (958 loc) · 69.4 KB

Changelog

All notable changes to Rover will be documented in this file.

This project adheres to Semantic Versioning.

[0.3.0] - 2021-09-24

Important: 1 breaking change below, indicated by ❗ BREAKING ❗

❗ BREAKING ❗

  • rover supergraph compose uses a newer composition function that is incompatible with older versions of @apollo/gateway - EverlastingBugstopper, issue/801 pull/832

    The 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 means rover 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.

🚀 Features

  • 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

🛠 Maintenance

  • 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.

📚 Documentation

  • Clarify --output json support in migration guide, and provide an example jq script - EverlastingBugstopper, issue/839 pull/840

    The 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.

[0.2.1] - 2021-09-20

🐛 Fixes

  • 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.

🛠 Maintenance

📚 Documentation

[0.2.0] - 2021-08-23

🚀 Features

  • 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.

🐛 Fixes

  • 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 than x86_64

🛠 Maintenance

📚 Documentation

  • 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.

[0.2.0-beta.1] - 2021-08-05

🐛 Fixes

  • 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.

📚 Documentation

  • 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.

[0.1.10] - 2021-08-05

🐛 Fixes

  • 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.

📚 Documentation

  • 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.

[0.2.0-beta.0] - 2021-07-26

🚀 Features

  • 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 level json_version key, and make sure to update your scripts when that version is not what you expect (the first version is 1.beta).

    We'd love your feedback on this new feature, or if you notice any bugs in your existing workflows, so please submit issues!

[0.1.9] - 2021-07-22

🚀 Features

  • Updates @tag/@inaccessible composition algorithm in rover 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

  • rover subgraph publish and rover subgraph delete now acknowledges operations with no composition errors. - EverlastingBugstopper, issue/632 pull/685

    Previously, 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.

🛠 Maintenance

  • Make the test process fail in CI if there are test failures - EverlastingBugstopper, pull/683

    For some reason, cargo test was exiting with code 0 even if there were failed tests. We run tests through our own custom xtask, so we've added a wrapper around cargo 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

📚 Documentation

[0.1.8] 2021-07-07

🚀 Features

  • Adds preview support for @tag and @inaccessible directives - EverlastingBugstopper, pull/631

    Preview support for composing subgraphs with @tag and/or @inaccessible core features using rover 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.

🐛 Fixes

  • 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.

🛠 Maintenance

[0.1.7] 2021-06-29

🚀 Features

  • 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.

🐛 Fixes

  • 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.

🛠 Maintenance

📚 Documentation

[0.1.6] 2021-06-08

🐛 Fixes

  • 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/586

    Once 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 of stderr due to a bug in an upstream dependency. This bug has now been fixed, and update messages are now properly routed to stderr.

📚 Documentation

  • 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/585

    Fixes an instance of subgraph push to be subgraph publish.

[0.1.5] 2021-05-25

🐛 Fixes

  • Vendor OpenSSL@v1.1 - 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 an apollo-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.

[0.1.4] (yanked)

[0.1.3] - 2021-05-25

🐛 Fixes

  • 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

[0.1.2] - 2021-05-20

🐛 Fixes

  • Fix unusable rover subgraph check - EverlastingBugstopper, issue/553 pull/555

    Rover 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!.

[0.1.1] - 2021-05-19

🚀 Features

  • 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-powered rover supergraph compose command.

    Our CI pipeline now produces a statically-linked binary compiled with musl-libc that does not include rover supergraph compose. Our installers will check if you have a compatible version of glibc, 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.

🐛 Fixes

  • 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.

📚 Documentation

[0.1.0] - 2021-05-11

Important: 2 breaking changes below, indicated by ❗ BREAKING ❗

❗ 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.

🚀 Features

  • rover supergraph fetch - EverlastingBugstopper, issue/452 pull/485

    This 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/519

    Pulls 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 to rover subgraph publish - EverlastingBugstopper, issue/169 pull/484

    When 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 first rover 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/457

    When encountering most errors in Rover, there will be an error code in the format E### printed along with the error description. Running rover 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/503

    There is a new migration guide from the old Apollo CLI to Rover, and this command will open that page for you.

🐛 Fixes

🛠 Maintenance

  • Removes unnecessary custom URL parser - EverlastingBugstopper, pull/493

    structopt will automatically use the FromStr implementation on the Url 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/516

    rover 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

📚 Documentation

[0.0.10] - 2021-04-27

🚀 Features

  • 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 requires glibc >= 2.7 to be installed. Previously, if you attempted to install Rover on a machine without glibc, you would get quite cryptic linker errors. Now, users attempting to install Rover without the proper glibc 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/459

    You 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 run rover subgraph check on a non-federated graph.

🐛 Fixes

  • 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!

🛠 Maintenance

📚 Documentation

[0.0.9] - 2021-04-13

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

🛠 Maintenance

  • ** 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.

[0.0.8] - 2021-04-13

🚀 Features

🐛 Fixes

  • 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.

🛠 Maintenance

  • Update telemetry URL - JakeDawkins, pull/427

    Telemetry is now routed through a Netlify function instead of a Cloudflare Worker.

📚 Documentation

  • 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.

[0.0.7] - 2021-04-01

🐛 Fixes

  • Updates URL base in Core Schema output to specs.apollo.dev - abernix, pull/418

📚 Documentation

[0.0.6] - 2021-03-31

🚀 Features

🐛 Fixes

  • Change 'CSDL' to 'Core Schema' - lrlna, pull/403

    Output of rover supergraph compose is a Core Schema. Our output previously indicated that it was a CSDL.

  • 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 getting killed on MacOS in v0.0.5 release. This was happening due to the fact that we are using deno-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.

[0.0.5] - 2021-03-30

Important: 2 breaking changes below, indicated by ❗ BREAKING ❗

🚀 Features

  • 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/372

    The 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.

❗ BREAKING ❗

  • Renames core build to supergraph compose - lrlna, pull/391

    To align with other Apollo teams on the usage of supergraph and composition, we are renaming core build to supergraph compose.

  • Updates harmonizer@0.2.2 - 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.

🐛 Fixes

  • 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.

🛠 Maintenance

  • 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

📚 Documentation

[0.0.4] - 2021-03-23

Important: Two breaking changes below, indicated by ❗ BREAKING ❗

🚀 Features

  • 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.

❗ BREAKING ❗

  • Rename push to publish 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 be publish.

  • Rename committer to author - EverlastingBugstopper, issue/338 pull/339

    Note: This is only breaking change if you were previously using the APOLLO_VCS_COMMITTER env variable. If so, migrate by changing that environment variable to APOLLO_VCS_AUTHOR.

    Changes the underlying git context implementation to report the author of a commit rather than a committer. This is primarily intended to properly link the real author with a commit in Apollo Studio.

🐛 Fixes

  • 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.

🛠 Maintenance

  • 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/346

    In preparation for future releases to crates.io, we've added relevant metadata to the Cargo.toml file for the project.

📚 Documentation

  • Adds APOLLO_HOME variable to docs - EverlastingBugstopper, pull/341

    APOLLO_HOME is the override variable for Rover's parent directory, where the binary lives. This was previously undocumented, but now it's not!

[0.0.3] - 2021-03-09

🚀 Features

  • ❗ BREAKING ❗ Squash config show functionality into config whoami - EverlastingBugstopper, issue/274 pull/323

    Since the only thing that rover config show did was show the saved api key, it made sense to squash that functionality into the whoami 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/307

    The whoami command, which is used to verify api keys and help with debugging now shows where that key came from, either a --profile or the APOLLO_KEY env variable.

  • rover docs commands to make viewing documentation easier - EverlastingBugstopper, issue/308 pull/314

    To make it easier to find and navigate Rover's docs, we added two commands: rover docs list to list helpful docs pages and rover 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.

🐛 Fixes

🛠 Maintenance

  • 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 up CARGO_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.

📚 Documentation

  • 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.

[0.0.2] - 2021-02-23

🚀 Features

  • 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 an arm64 architecture. We have updated our curl | sh installer and our npm installer to reflect this, and anybody running Big Sur on the new M1 machines can now install and use Rover.

  • Add a > prompt to the rover config auth command - EverlastingBugstopper, issue/279 pull/281

    It 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 displaying Name information which was unclear in the context of this command. Instead of Name, we are now displaying Service title information for graph keys, and omitting Name and Service Title for user keys, as the already existing information provides enough information for User.

🐛 Fixes

  • 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/

🛠 Maintenance

  • 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 (from rover config auth)/

📚 Documentation

  • 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 through npx.

  • 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.

[0.0.1] - 2021-02-09

Initial beta release. Please visit our documentation page for information on usage.