Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mstachniuk committed Dec 13, 2024
1 parent fe69e6a commit 9801c2e
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,29 +22,40 @@ If you are on Windows, read the [sonar-go-to-slang/README.md](sonar-go-to-slang/
### Build
Build and run Unit Tests:

./gradlew build

```shell
./gradlew build
```
`
## Integration Tests

By default, Integration Tests (ITs) are skipped during builds.
If you want to run them, you need first to retrieve the related projects which are used as input:

git submodule update --init its/sources
```shell
git submodule update --init
```

Then build and run the Integration Tests using the `its` property:

```shell
./gradlew build -Pits --info --no-daemon
```

You can also build and run only Ruling Tests using the `ruling` property:

./gradlew build -Pruling --info --no-daemon
```shell
./gradlew build -Pruling --info --no-daemon
```

## License headers

License headers are automatically updated by the spotless plugin but only for Java files.
Furthermore, there are files such as `package-info.java` and `module-info.java` that spotless ignores.
Also the Go source files are not handled. For those files use a manual script like below to update the license:
`find . -type f -name "*.go" -exec sed -i '' 's/2018-2023/2018-2024/' "{}" \;`

```shell
`find . -type f -name "*.go" -exec sed -i '' 's/2018-2023/2018-2024/' "{}" \;`
```

## License

Expand Down

0 comments on commit 9801c2e

Please sign in to comment.