Skip to content

Commit defae97

Browse files
committed
docs/make-release.md: Added section for Release Audit Tool
1 parent 508b39b commit defae97

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

docs/make-release.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ This project uses Nerdbank.GitVersioning to assist with creating version numbers
44

55
## Prerequisites
66

7+
- [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) 6.0 or higher (see [this question](http://stackoverflow.com/questions/1825585/determine-installed-powershell-version) to check your PowerShell version)
78
- [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
89
- [nbgv tool](https://www.nuget.org/packages/nbgv/) (the version must match the one defined in [Directory.Packages.props](../Directory.Packages.props))
10+
- [Java 8](https://adoptium.net/temurin/releases) or higher (either a JRE or JDK)
911

1012
### Installing NBGV Tool
1113

@@ -15,6 +17,20 @@ Perform a one-time install of the nbgv tool using the following dotnet CLI comma
1517
dotnet tool install -g nbgv --version <theActualVersion>
1618
```
1719

20+
## Run the Apache Release Audit Tool
21+
22+
The Release Audit Tool will ensure that all non-generated text files have a license header.
23+
24+
```console
25+
pwsh ./rat.ps1
26+
```
27+
28+
The tool will apply the updates directly to the local working directory. Review and commit the changes to your local Git clone, adding exclusions to `.rat-excludes` and re-running as necessary.
29+
30+
- Exclude files that already have license headers
31+
- Exclude files that are automatically generated
32+
- Exclude files that don't work properly with license headers included (such as test data)
33+
1834
## Versioning Primer
1935

2036
This project uses [Semantic Versioning 2.0](https://semver.org/spec/v2.0.0.html) and strictly adheres to the guidelines about bumping the major, minor and build numbers of the version number.

0 commit comments

Comments
 (0)