Skip to content

Commit

Permalink
Add instructions on how to publish artefacts
Browse files Browse the repository at this point in the history
- Update README.MD with instructions on how to publish artefacts for the
utils and library modules
  • Loading branch information
ekigamba committed Nov 1, 2022
1 parent 4b5b1b1 commit 0658890
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,21 @@ For instructions on how to run the sample app see [these instructions](./sample/

### How to publish artifacts

Due to the sunsetting of JFrog Bintray, Kujaku artefacts/release are no longer available on bintray and all publishing is done to Maven Central. Some of the packages are also published to Github packages.
You can easily publish a snapshot artefact by creating a tag for the library or util module. Follow the steps below:

#### To publish the utils module
1. Update the `utils` version in this file `utils\build.gradle` in the format `X.Y.Z-SNAPSHOT` where X, Y and Z should be replaced with the version numbers of the major vesion, minor version and build versions respectively.
2. Create a PR with the change and have it merged
3. Generate a tag with the title `utils-vX.Y.X-SNAPSHOT` and push it. This will trigger a publish of the artefact snapshot version to Sonatype and Github packages

#### To publish the library module

1. Follow the steps above to get the latest version of `utils` as a dependency in your library snapshot
2. Update the `library` version in this file `library\build.gradle` in the format `X.Y.Z-SNAPSHOT` where X, Y and Z should be replaced with the version numbers of the major vesion, minor version and build versions respectively.
2. Create a PR with the change and have it merged
3. Generate a tag with the title `library-vX.Y.X-SNAPSHOT` and push it. This will trigger a publish of the artefact snapshot version to Sonatype and Github packages

- Due to the sunsetting of JFrog Bintray, Kujaku artefacts/release are no longer available on bintray and all publishing is done to Maven Central. Some of the packages are also published to Github packages.

## How to import the library

Expand Down Expand Up @@ -70,7 +84,7 @@ dependencies {

The library offers a view `KujakuMapView` that provides more functionality than Mapbox.
- For Mapbox related functionality, [go here](https://docs.mapbox.com/android/maps/overview/)
- For extra features provided by this library [go here](./SPECIFICATION.md)
- For setup information and extra features provided by this library [go here](./SPECIFICATION.md)

## `Unable to resolve artifact: Missing` while running tests

Expand Down

0 comments on commit 0658890

Please sign in to comment.