Skip to content

Commit

Permalink
Add note about disabling windows/mac builds for private repos
Browse files Browse the repository at this point in the history
It'll destroy your GHA minutes.
  • Loading branch information
will-molloy committed Apr 21, 2024
1 parent ed9a134 commit 991c6f5
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![build](https://github.com/will-molloy/java-gradle-template/workflows/build/badge.svg?branch=main&event=push)](https://github.com/will-molloy/java-gradle-template/actions?query=workflow%3Abuild)
[![codecov](https://codecov.io/gh/will-molloy/java-gradle-template/branch/main/graph/badge.svg)](https://codecov.io/gh/will-molloy/java-gradle-template)

template repository for Java projects using Gradle
template repo for Java projects using Gradle

## Features

Expand All @@ -20,16 +20,17 @@ template repository for Java projects using Gradle
## Usage

- Click [Use this template](https://github.com/will-molloy/java-gradle-template/generate)
- This will prompt you to create a new repository with all the files setup
- This will prompt you to create a new repo with all the files setup
- Rename the root project (currently `java-gradle-template`) and group (currently `com.willmolloy`) to your liking
- Delete anything you won't use (sub projects, dependencies, etc.)
- Update the README
- Other non-code setup like your GitHub branch protections
- **NOTE:** if creating a private repo, you probably want to disable the windows and mac builds

### Build and test

```
./gradlew build integrationTest
./gradlew spotlessApply build integrationTest
```

### Upgrade Gradle
Expand Down

0 comments on commit 991c6f5

Please sign in to comment.