Skip to content

Commit 0bcfc53

Browse files
committed
Added breaking changes documentation
1 parent 8f571a0 commit 0bcfc53

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

BREAKING_CHANGES.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
AzureWebFarm.OctopusDeploy Breaking Changes
22
===========================================
33

4+
Version 2.0.0
5+
-------------
6+
7+
### OctopusDeploy 3 Support
8+
9+
We now use the API client library from Octopus Deploy 3 - it's likely that this would break Octopus Deploy 2 so use with caution ifi you are still on 2 or use the 1.x series of AzureWebFarm.OctopusDeploy.
10+
11+
### `WebFarmRole.Run()` signature changed
12+
13+
WebFarm role now takes a `CancellationToken` and returns a `Task` so it can be awaited. This makes it easier to support other code running side-by-side in your role and exert more control over the `Run` method.
14+
15+
If you want the behaviour to stay the same as before then put the following in your `WebRole` (RoleEntryPoint) class `Run` method:
16+
17+
```c#
18+
public override void Run()
19+
{
20+
Task.Run(() => _webFarmRole.Run(new CancellationTokenSource().Token)).Wait();
21+
}
22+
```
23+
424
Version 1.2.0
525
-------------
626

0 commit comments

Comments
 (0)