Skip to content

Commit

Permalink
Add README section for local development
Browse files Browse the repository at this point in the history
  • Loading branch information
lauzadis committed May 25, 2024
1 parent b06af71 commit c249dbb
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<YOUR_SNAPSHOT_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)
Expand Down

0 comments on commit c249dbb

Please sign in to comment.