Migration.md

Note on deprecations

A tick-tock release cycle allows easy migration to new software versions. Obsolete code is marked as deprecated for one major release. Deprecated code produces compile-time warnings. These warning serve as notification to users that their code should be upgraded. The next major release will remove the deprecated code.

Ignition Transport 9.X to 10.X

Addition

1. Dependency on cli component of ignition-utils.
   • GitHub pull request 229

Ignition Transport 8.X to 9.X

Removed

1. Remove deprecations before 9.x.x release
   • GitHub pull request 175

Ignition Transport 7.X to 8.X

Deprecated

1. NodeShared::TriggerSubscriberCallbacks

   • BitBucket pull request 404

2. The discovery wire protocol changed to use ignition::msgs::Discovery instead of C-structs. The Packet.hh header file is deprecated, which contained the Header, SubscriptionMsg, and AdvertiseMessage classes. The version of the wire protocal has bumped from 9 to 10. This means Ignition Transport 8+ will not work with Ignition Transport 7 and below.

   • BitBucket pull request 403

Ignition Transport 6.X to 7.X

Removed

1. The ign.hh file is not longer installed.
   • BitBucket pull request 367

Ignition Transport 4.X to 5.X

Ignition Transport 3.X to 4.X

1. Service responder callbacks passed to Node::Advertise should now return a boolean value instead of taking in a boolean output parameter. The existing functions have been deprecated.
   • BitBucket pull request 260
   • BitBucket pull request 228