From 991c6f51e81fd8fe0c9eec58ae0811b084ac9a69 Mon Sep 17 00:00:00 2001 From: Will Molloy Date: Sun, 21 Apr 2024 17:17:34 +1200 Subject: [PATCH] Add note about disabling windows/mac builds for private repos It'll destroy your GHA minutes. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 254692d..ce2a898 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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