Skip to content

Commit acedd7b

Browse files
committed
update readme
1 parent 719797c commit acedd7b

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ dotnet new --install BuildProject::*
2323
### Template Parameters
2424

2525
```
26+
BuildProject (F#)
27+
Author: Kevin Schneider
28+
2629
Usage:
2730
dotnet new BuildProject [options] [template options]
2831
@@ -50,6 +53,10 @@ Template options:
5053
net6.0
5154
Type: string
5255
Default: net6.0
56+
-ipv, --individual-package-versions If set, the build project will support individual package versions and
57+
release notes per project.
58+
Type: bool
59+
Default: false
5360
```
5461

5562
### Basic use case
@@ -174,3 +181,27 @@ in your project root, you can create these scripts so you have to type less:
174181
175182
dotnet run --project ./build/build.fsproj "$@"
176183
```
184+
185+
### Setting up individual project versions and release notes
186+
187+
Since v3.0.0, the template supports individual project versions and release notes per project.
188+
189+
This is helpful in a monorepo that contains projects that have decoupled versions, instead of having the same version for all projects per release..
190+
191+
To enable this feature, use the `--individual-package-versions` flag when creating the template.
192+
193+
The rest of the setup is quite similar to the basic usecase, with the difference that you have to specify both projects and testprojects in `ProjectInfo.fs` using the `ProjectInfo` type.
194+
195+
```fsharp
196+
let projects =
197+
[
198+
// add relative paths (from project root) to your projects here, including individual reslease notes files
199+
// e.g. ProjectInfo.create("MyProject", "src/MyProject/MyProject.fsproj", "src/MyProject/RELEASE_NOTES.md") // a project with individual release notes
200+
]
201+
202+
let testProjects =
203+
[
204+
// add relative paths (from project root) to your testprojects here
205+
// e.g. ProjectInfo.create("MyTestProject", "tests/MyTestProject/MyTestProject.fsproj") // test projects do not have release notes.
206+
]
207+
```

0 commit comments

Comments
 (0)