Skip to content

Latest commit

 

History

History
155 lines (104 loc) · 9.56 KB

CHANGELOG.md

File metadata and controls

155 lines (104 loc) · 9.56 KB

Changelog

[Unreleased]

Changes that have landed in master but are not yet released. Click to see more.

v0.13.0 - 2019-05-02

Components

Breaking Changes

  • srcd commands do not have a -v/--verbose flag anymore, it has been replaced with the --log-level=debug option (#410).
  • Command srcd parse drivers list has been renamed to srcd parse drivers (#320).
  • The srcd/cli-daemon docker image executable now requires to use the serve sub command. This does not affect end users (#410).

New Features

  • New srcd config command. A convenient way to open your ~/.srcd/config.yml file, populating it with the default config values if it is empty (#422).

  • The srcd commands now have the following new options for log messages (#410):

    --log-level=[info|debug|warning|error] Logging level (default: info) [$LOG_LEVEL]
--log-format=[text|json]               log format, defaults to text on a terminal and json otherwise [$LOG_FORMAT]
--log-fields=                          default fields for the logger, specified in json [$LOG_FIELDS]
--log-force-format                     ignore if it is running on a terminal or not [$LOG_FORCE_FORMAT]

  • New command srcd components start component(s), to start individual source{d} components containers (#433).

  • The gitbase container can be very CPU intensive and some queries can cause the host to freeze. Now the container is started with a limit on the available host CPU (#452).

  • Bash completion for srcd sub commands. For installation instructions go to the Quick Start docs (#455).

Bug Fixes

  • The commands fail gracefully if an incompatible Docker installation is found, such as Docker Toolbox (#417).

Known Issues

  • #297: srcd parse does not detect the language automatically for bash files. For this language you will need to set --lang manually. For example: 
    $ srcd parse uast file.bash --lang bash

v0.12.0 - 2019-04-04

Breaking Changes

In this release we have changed how Engine stores the gitbase index data. In previous releases we stored this data in ~/.srcd/gitbase. From now on they will be managed as docker volumes.

This change has 2 implications:

  • If you had created any index for your data you will need to recreate them after source{d} Engine is updated.

  • The files in ~/.srcd/gitbase are not used anymore, and you need to clean them manually:

    rm -rf ~/.srcd/gitbase

    Please note that in Linux you may need to run the command as root.

This manual cleanup will not be necessary after you install this version. The srcd prune command will delete volumes containing the gitbase index data.

Components

New Features

  • More friendly and useful error messages (#252, #258, #272, #291, #294, #295, #326).
  • Replace the basic REPL SQL shell with a standard MySQL client (#154).
  • Show the container exposed ports in the srcd components list output (#300).
  • Set delegated consistency mode for mounted volumes on macOS. This improves SQL queries performance (#330).
  • Use volumes for gitbase index data persistence (#373).

Bug Fixes

  • Fix the gRCP ResourceExhausted error for srcd parse uast with big files (#271).
  • In cases where the workdir contains a lot of Git repositories, srcd web sql could open the web UI before gitbase was ready to accept queries (#284).
  • If the daemon container crashed, or was stopped directly by the user, the following srcd commands are able to restart it. But then it would not honor the working directory used when srcd init /path/workdir was called, using instead the current directory. Now Engine stores a file in ~/.srcd/ to solve this (#372).
  • When gitbase was started Engine created unnecessary anonymous volumes that were not attached to any container. These volumes were also ignored by srcd prune (#371).

Known Issues

  • #297: srcd parse does not detect the language automatically for C#, C++, or bash files. For these languages you will need to set --lang manually. For example:
$ srcd parse uast file.cs --lang csharp
$ srcd parse uast file.cpp --lang cpp
$ srcd parse uast file.bash --lang bash

v0.11.0 - 2019-03-08

Components

Windows Support

This release brings back windows binaries. source{d} Engine has been tested on Windows 10 (#235).

New Features

You can now manage the public ports of the components containers, using a YAML config file. This allows you to avoid port conflicts with other services that may be using the default ports. For more information see the CLI documentation (#236).

Known Issues

  • #297: srcd parse does not detect the language automatically for C#, C++, or bash files. For these languages you will need to set --lang manually. For example:
$ srcd parse uast file.cs --lang csharp
$ srcd parse uast file.cpp --lang cpp
$ srcd parse uast file.bash --lang bash
  • [Windows only] #349: Engine cannot handle gitbase indexes.
  • [Windows only] #257: srcd sql REPL prints unix terminal control characters.

v0.10.0 - 2019-02-22

Components

Windows Support

This release does not include windows binaries. We are working on ensuring windows is properly supported and it will be included in the next releases.

Bug Fixes

  • Fix connection refused errors when gitbase takes time to process the working directory repositories. Now engine waits until it is ready, showing a nice spinner (#195, #216).
  • Fix error message error while marshaling: proto: invalid UTF-8 string for SQL queries including UAST columns (#196).
  • Use higher timeouts when starting and stopping containers (#207, #213).
  • Add the optional working directory argument in the output of srcd init -h (#203).

v0.8.0 - 2019-01-22

Components

  • srcd/gitbase-web has been updated to v0.5.0.
  • bblfsh/web has been updated to v0.9.0.

New Features

  • srcd sql now installs the dependencies right after it is started, instead of waiting for the user to submit the first query (#152).
  • All the srcd parse drivers management commands have been removed, except for drivers list. They are not needed anymore, now that source{d} Engine ships with pre-installed drivers, using fixed versions (#85).
  • More user-friendly error message for unknown languages in the srcd parse output (#163).