From c249dbbd2e40de57f322a0043a779cc55e6621d0 Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Sat, 25 May 2024 13:00:02 +0200 Subject: [PATCH] Add README section for local development --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d318b6b..d018afc 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,14 @@ To cut a new release: 7. Specify the tag you created under `Source Version`. 8. Start the build. -## Projects +## Development + +### Local development +To use a local version of the plugin in downstream projects (such as `smithy-kotlin` or `aws-sdk-kotlin`): +1. Run `./gradlew -Prelease.version= publishToMavenLocal` +2. Consume the snapshot plugin version in the projects + +### Project Structure * `:build-plugins:build-support` - common build support (publishing, linting, utils, etc) * `:build-plugins:kmp-conventions` - Plugin that applies common conventions for KMP projects (source sets, targets, etc)