@@ -21,7 +21,7 @@ Clone the project and download Cake tools by running the following command at ro
2121dotnet tool restore
2222```
2323
24- Running ` .\build-cake .cmd ` (Windows) or ` ./build-cake .sh ` (Unix/macOS) will start the build process. By default it builds the NetStandard project.
24+ Running ` .\build.cmd ` (Windows) or ` ./build.sh ` (Unix/macOS) will start the build process. By default it builds the NetStandard project.
2525
2626## Build Commands
2727
@@ -30,28 +30,28 @@ We have a dedicated NetFramework project targeting .NET Framework 4.6+.
3030
3131** Windows:**
3232``` cmd
33- .\build-cake .cmd --target=Build.NetFramework
33+ .\build.cmd --target=Build.NetFramework
3434```
3535
3636### Build NetStandard
3737NetStandard currently supports explicit targets for netstandard2.0, net6.0 and net7.0.
3838
3939** Windows:**
4040``` cmd
41- .\build-cake .cmd --target=Build.NetStandard
41+ .\build.cmd --target=Build.NetStandard
4242```
4343
4444** Unix/macOS:**
4545``` bash
46- ./build-cake .sh --target=Build.NetStandard
46+ ./build.sh --target=Build.NetStandard
4747```
4848
4949### Build Xamarin
5050We have a Xamarin solution targeting Android and iOS.
5151
5252** Unix/macOS:**
5353``` bash
54- ./build-cake .sh --target=Build.Xamarin
54+ ./build.sh --target=Build.Xamarin
5555```
5656
5757## Test Commands
@@ -60,74 +60,69 @@ We have a Xamarin solution targeting Android and iOS.
6060
6161** Run unit tests:**
6262``` cmd
63- .\build-cake .cmd --target=Test.NetFramework.Unit
64- .\build-cake .cmd --target=Test.NetFramework.Unit.WithRetry # Retry failed tests
63+ .\build.cmd --target=Test.NetFramework.Unit
64+ .\build.cmd --target=Test.NetFramework.Unit.WithRetry # Retry failed tests
6565```
6666
6767** Run integration tests:**
6868``` cmd
69- .\build-cake .cmd --target=Test.NetFramework.Integration
70- .\build-cake .cmd --target=Test.NetFramework.Integration.WithRetry # Retry failed tests
69+ .\build.cmd --target=Test.NetFramework.Integration
70+ .\build.cmd --target=Test.NetFramework.Integration.WithRetry # Retry failed tests
7171```
7272
7373### Test NetStandard
7474
7575** Run unit tests:**
7676``` bash
77- ./build-cake .sh --target=Test.NetStandard.Unit
78- ./build-cake .sh --target=Test.NetStandard.Unit.WithRetry # Retry failed tests
77+ ./build.sh --target=Test.NetStandard.Unit
78+ ./build.sh --target=Test.NetStandard.Unit.WithRetry # Retry failed tests
7979```
8080
8181** Run integration tests:**
8282``` bash
83- ./build-cake .sh --target=Test.NetStandard.Integration
84- ./build-cake .sh --target=Test.NetStandard.Integration.WithRetry # Retry failed tests
83+ ./build.sh --target=Test.NetStandard.Integration
84+ ./build.sh --target=Test.NetStandard.Integration.WithRetry # Retry failed tests
8585```
8686
8787** Target specific framework:**
8888
8989Additional ` --framework ` flag can be supplied to test for target framework ` net6.0 ` or ` net7.0 ` :
9090``` bash
91- ./build-cake .sh --target=Test.NetStandard.Unit --framework=net6.0 # Run tests for .NET 6.0 runtime
92- ./build-cake .sh --target=Test.NetStandard.Unit --framework=net7.0 # Run tests for .NET 7.0 runtime
91+ ./build.sh --target=Test.NetStandard.Unit --framework=net6.0 # Run tests for .NET 6.0 runtime
92+ ./build.sh --target=Test.NetStandard.Unit --framework=net7.0 # Run tests for .NET 7.0 runtime
9393```
9494
9595## Create NuGet Packages
9696
9797Currently, we have two scripts to generate NuGet packages:
9898
99- ### 1. package-cake.sh / package-cake .cmd
99+ ### 1. package.cmd
100100
101- Responsible for creating core ` ably.io ` NuGet package.
101+ - Responsible for creating core ` ably.io ` NuGet package.
102+ - Works only on Windows due to a dependency on the .NET Framework.
102103
103- ** Unix/macOS:**
104- ``` bash
105- ./package-cake.sh 1.2.3
106- ```
107-
108- ** Windows:**
109104``` cmd
110- .\package-cake .cmd 1.2.3
105+ .\package.cmd 1.2.3
111106```
112107
113108Above command creates ` ably.io.1.2.3.nupkg ` package at root.
114109
115110During release process, this package is hosted on [ nuget.org/packages/ably.io] ( https://www.nuget.org/packages/ably.io ) .
116111
117- ### 2. package-push-cake .sh / package-push-cake .cmd
112+ ### 2. package-push.sh / package-push.cmd
118113
119114Responsible for creating push packages for Android and iOS.
120115
121116Please take a look at [ Push Notification Documentation] ( ../PushNotifications.md ) for usage.
122117
123118** Unix/macOS:**
124119``` bash
125- ./package-push-cake .sh 1.2.3
120+ ./package-push.sh 1.2.3
126121```
127122
128123** Windows:**
129124``` cmd
130- .\package-push-cake .cmd 1.2.3
125+ .\package-push.cmd 1.2.3
131126```
132127
133128Above command creates ` ably.io.push.android.1.2.3.nupkg ` and ` ably.io.push.ios.1.2.3.nupkg ` packages at root.
@@ -140,34 +135,34 @@ During release process, these packages are hosted on:
140135
141136### Build with specific configuration
142137``` bash
143- .\b uild-cake .cmd --target=Build.NetStandard --configuration=Debug
138+ .\b uild.cmd --target=Build.NetStandard --configuration=Debug
144139```
145140
146141### Build with custom constants
147142``` bash
148- .\b uild-cake .cmd --target=Build.NetStandard --define=MY_CONSTANT
143+ .\b uild.cmd --target=Build.NetStandard --define=MY_CONSTANT
149144```
150145
151146### Verbose output
152147``` bash
153- .\b uild-cake .cmd --target=Build.NetStandard --verbosity=diagnostic
148+ .\b uild.cmd --target=Build.NetStandard --verbosity=diagnostic
154149```
155150
156151### List all available targets
157152``` bash
158- .\b uild-cake .cmd --description
153+ .\b uild.cmd --description
159154```
160155
161156** Note:** This command shows all tasks including internal tasks (starting with ` _ ` ). Internal tasks are implementation details and should not be called directly. Use the public targets listed in this README instead.
162157
163158### Show task dependency tree
164159``` bash
165- .\b uild-cake .cmd --tree
160+ .\b uild.cmd --tree
166161```
167162
168163### Dry run (test without execution)
169164``` bash
170- .\b uild-cake .cmd --target=Build.NetStandard --dryrun
165+ .\b uild.cmd --target=Build.NetStandard --dryrun
171166```
172167
173168## Resources
0 commit comments