Skip to content

Commit

Permalink
Added instructions for publishing schemas to mavenLocal
Browse files Browse the repository at this point in the history
  • Loading branch information
blootsvoets authored and this-Aditya committed May 3, 2023
1 parent d8f8f63 commit fcbd178
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .snyk
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ ignore:
SNYK-JAVA-ORGJETBRAINSKOTLIN-2393744:
- '*':
reason: Not using createTempFile/Dir
expires: 2022-10-27T10:04:03.174Z
expires: 2023-10-27T10:04:03.174Z
created: 2022-06-27T10:04:03.177Z
patch: {}
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ repositories {
mavenCentral()
}
dependencies {
api 'org.radarbase:radar-commons-android:1.2.1'
api 'org.radarbase:radar-commons-android:1.2.2'
}
```

Include additional plugins by adding:

```gradle
dependencies {
implementation 'org.radarbase:<plugin name>:1.2.1'
implementation 'org.radarbase:<plugin name>:1.2.2'
}
```

Expand Down Expand Up @@ -97,6 +97,35 @@ To only build plugins that are of interest to you, add a `gradle.skip` file in a

If you want to contribute a feature or fix browse our [issues](https://github.com/RADAR-base/radar-commons-android/issues), and please make a pull request.

## Publishing Schemas to Maven Local

While the plugin is in development phase schemas are not published centrally. To access the java generated file from avro schemas first publish them to maven local.
To publish schemas locally to Maven, please follow these steps:

1. Change your working directory to java-sdk in RADAR-Schemas.

2. Run the following commands in your terminal:
```shell
./gradlew build
./gradlew publishToMavenLocal
```

3. In your build.gradle file, add the following to your repositories block:
```gradle
repositories {
mavenLocal()
}
```

4. In the same build.gradle file, add the following to your dependencies block, replacing `$radarSchemasVersion` with its corresponding value:
```gradle
dependencies {
implementation "org.radarbase:radar-schemas-commons:$radarSchemasVersion"
}
```

You can find the version value in the metadata of your local Maven repository. It should end in `SNAPSHOT`.

## Licensing

Code made in the RADAR-base platform is licensed under the Apache License 2.0, as listed in see the LICENSE file in this directory. Plugins that have additional licensing requirements list them in their README.

0 comments on commit fcbd178

Please sign in to comment.