Skip to content

Commit ca7596f

Browse files
committed
2 parents 7c5817b + 54cef57 commit ca7596f

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Aardvark.Build
22

3-
![Publish](https://github.com/aardvark-platform/aardvark.build/workflows/Publish/badge.svg)
4-
[![NuGet](https://badgen.net/nuget/v/Aardvark.Build)](https://www.nuget.org/packages/Aardvark.Build/)
5-
[![NuGet](https://badgen.net/nuget/dt/Aardvark.Build)](https://www.nuget.org/packages/Aardvark.Build/)
3+
[![Publish](https://github.com/aardvark-platform/aardvark.build/workflows/Publish/badge.svg)](https://github.com/aardvark-platform/aardvark.build/actions/workflows/pack.yml)
4+
[![Nuget](https://img.shields.io/nuget/vpre/aardvark.build)](https://www.nuget.org/packages/aardvark.build/)
5+
[![Downloads](https://img.shields.io/nuget/dt/aardvark.build)](https://www.nuget.org/packages/aardvark.build/)
66

77
MSBuild tasks for the Aardvark platform that automate versioning, native dependency management, and cross-repository development workflows.
88

@@ -142,16 +142,20 @@ dotnet tool restore # for other developers
142142
aardpack [options] <solution/project files>
143143
```
144144

145-
Key options:
145+
Options:
146146
| Option | Description |
147147
|--------|-------------|
148-
| `--version` | Show version and exit |
149-
| `--parse-only` | Extract version from release notes (returns `0.0.0.0` on failure) |
150-
| `--configuration` | Build configuration (default: Release) |
151-
| `--output <dir>` | Package output directory (default: `bin/pack`) |
152-
| `--no-release` | Skip GitHub release creation |
153-
| `--dry-run` | Simulate operations without executing |
154-
| `--per-project` | Create individual releases per project |
148+
| `--version` | Show version and exit. |
149+
| `--parse-only` | Extract version from release notes (returns `0.0.0.0` on failure). |
150+
| `--configuration <config>` | Build configuration (default: Release). |
151+
| `--release-notes <file>` | Path to the release notes file to use for all targets. If omitted, the release notes file is located automatically. |
152+
| `--output <dir>` | Package output directory (default: `bin/pack`). |
153+
| `--no-build` | Skip the build and pack steps. The files in arguments will be added to the Github release directly. |
154+
| `--skip-build` | Skip the build step but create packages normally in contrast to `--no-build`. |
155+
| `--no-release` | Skip GitHub release creation. |
156+
| `--no-tag` | Do not create a Git tag. Note that this option only has an effect in conjunction with `--no-release` as a tag will be created for each release. |
157+
| `--dry-run` | Simulate operations without executing. |
158+
| `--per-project` | Create a tag and release for each project and package. E.g., Aardvark.Base.csproj results in a tag `aardvark.base/1.2.3.4` and release titled `Aardvark.Base - 1.2.3.4`. |
155159

156160
### GitHub Actions Integration
157161

@@ -201,4 +205,4 @@ With a GitHub token present, `aardpack` will:
201205

202206
- [Paket](https://github.com/fsprojects/Paket) package manager
203207
- [FAKE](https://github.com/fsprojects/FAKE) (used internally for release notes parsing)
204-
- .NET SDK
208+
- .NET SDK

0 commit comments

Comments
 (0)