Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@

# CHANGELOG

## 1.0.0-beta04 (2026-03-06)

- Added option to include `projectGuardCheck` as part of the build tasks with the following:

```kotlin
projectGuard {
options {
lifecycleTask = LifecycleTask.ASSEMBLE // Or LifecycleTask.CHECK
}
}
```

- Fixed some tasks not being cached correctly

## 1.0.0-beta03 (2026-03-03)

- Most of plugin's tasks are now cacheable
Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,25 @@ ProjectGuard protects your project's architecture by enforcing dependency rules

## How-to


### Decide when you want to validate the rules

```kotlin
projectGuard {
options {
// Default behavior: no immediate validation checks.
// Use `./gradlew projectGuardAggregateCheck` manually
lifecycleTask = null

// This will validate the rules during the assemble lifecycle task
lifecycleTask = LifecycleTask.ASSEMBLE

// This will validate the rules during the check lifecycle task
lifecycleTask = LifecycleTask.CHECK
}
}
```

### `guard`

Denies a set of dependencies for any module that matches the provided path.
Expand Down Expand Up @@ -91,6 +110,10 @@ projectGuard {
allow(":domain") // Allow depending on other :domain modules
allow(libs.junit) // Allow JUnit for testing
}
restrictModule(":feature") {
allow(":domain")
allowExternalLibraries()
}
}
```

Expand Down