CHANGELOG.md

   1 # Changelog
   2
   3 This file lists changes for the GoVPP releases.
   4
   5 <!-- TEMPLATE
   6 ### Fixes
   7 -
   8 ### Features
   9 -
  10 ### Other
  11 -
  12 -->
  13
  14 ## 0.4.0 (in development)
  15 > _NOT RELEASED YET_
  16
  17 ### Binapi Generator
  18 - generator code has been split into multiple packages:
  19   - [vppapi](binapigen/vppapi) - parses VPP API (`.api.json`) files
  20   - [binapigen](binapigen) - processes parsed VPP API and handles code generation
  21 - previously required manual patches for generated code should not longer be needed
  22 - any types imported from other VPP API (`*_types.api`) files are now automatically resolved for generated Go code
  23 - dependency on `github.com/lunixbochs/struc` was removed and message un/marshaling is now part of generated code
  24 - generated code now contains comment with information about versions of VPP and binapi-generator
  25 - RPC service code is now generated into a separated file (`*_rpc.ba.go`) in same directory
  26 - many generated aliases were removed and referenced to `*_types` files for simpler reading
  27 - generated new helper methods for more convenient IP and MAC address conversion
  28
  29 ### Features
  30 - optimized [socketclient](adapter/socketclient) adapter and add method to set client name
  31 - added list of compatible messages to `CompatibilityError`
  32 - removed global binary API adapter - this change allows GoVPP to manage multiple VPP connections with different
  33   sockets simultaneously
  34
  35 ### Fixes
  36 - `MsgCodec` will recover panic occurring during a message decoding
  37 - calling `Unsubscibe` will close the notification channel
  38
  39 ### Other
  40 - improved log messages to provide more relevant info
  41
  42 #### Examples
  43 - added more code samples of working with unions in [union example](examples/union-example)
  44 - added profiling mode to [perf bench](examples/perf-bench) example
  45 - improved [simple client](examples/simple-client) example to work properly even with multiple runs
  46 - added [multi-vpp](examples/multi-vpp) example displaying management of two VPP instances from single
  47   application
  48
  49 #### Dependencies
  50 - updated `github.com/sirupsen/logrus` dep to `v1.6.0`
  51 - updated `github.com/lunixbochs/struc` dep to `v0.0.0-20200521075829-a4cb8d33dbbe`
  52
  53 ## 0.3.5
  54 > _18 May 2020_
  55
  56 ### Fixes
  57 - statsclient: Fix stats data errors and panic for VPP 20.05
  58
  59 ## 0.3.4
  60 > _17 April 2020_
  61
  62 ### Features
  63 - binapi-generator: Format generated Go source code in-process
  64
  65 ## 0.3.3
  66 > _9 April 2020_
  67
  68 ### Fixes
  69 - proxy: Unexport methods that do not satisfy rpc to remove warning
  70
  71 ## 0.3.2
  72 > _20 March 2020_
  73
  74 ### Fixes
  75 - statsclient: Fix panic occurring with VPP 20.05-rc0 (master)
  76
  77 ## 0.3.1
  78 > _18 March 2020_
  79
  80 ### Fixes
  81 - Fix import path in examples/binapi
  82
  83 ## 0.3.0
  84 > _18 March 2020_
  85
  86 ### Fixes
  87 - binapi-generator: Fix parsing default meta parameter
  88
  89 ### Features
  90 - api: Improve compatibility checking with new error types:
  91   `adapter.UnknownMsgError` and `api.CompatibilityError`
  92 - api: Added exported function `api.GetRegisteredMessageTypes()`
  93   for getting list of all registered message types
  94 - binapi-generator: Support imports of common types from other packages
  95 - binapi-generator: Generate `Reset()` method for messages
  96 - binapi-generator: Compact generated methods
  97
  98 ### Other
  99 - deps: Update `github.com/bennyscetbun/jsongo` to `v1.1.0`
 100 - regenerate examples/binapi for latest VPP from stable/2001
 101
 102 ## 0.2.0
 103 > _04 November 2019_
 104
 105 ### Fixes
 106 - fixed socketclient for 19.08
 107 - fixed binapi compatibility with master (20.01-rc0)
 108 - fixed panic during stat data conversion
 109
 110 ### Features
 111 - introduce proxy for remote access to stats and binapi
 112 - optimizations for statclient
 113
 114 ### Other
 115 - migrate to Go modules
 116 - print info for users when sockets are missing
 117
 118 ## 0.1.0
 119 > _03 July 2019_
 120
 121 The first release that introduces versioning for GoVPP.