https://github.com/knotx/knotx-gradle-plugins

Gradle plugins that help manage Knot.x modules builds.
https://github.com/knotx/knotx-gradle-plugins

Last synced: about 2 months ago
JSON representation

Gradle plugins that help manage Knot.x modules builds.

• Host: GitHub
• URL: https://github.com/knotx/knotx-gradle-plugins
• Owner: Knotx
• License: apache-2.0
• Created: 2019-06-13T10:42:44.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-16T07:36:48.000Z (10 months ago)
• Last Synced: 2024-03-21T20:37:46.886Z (10 months ago)
• Language: Kotlin
• Homepage: https://knotx.io
• Size: 234 KB
• Stars: 1
• Watchers: 8
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Build Status](https://dev.azure.com/knotx/Knotx/_apis/build/status/Knotx.knotx-gradle-plugins?branchName=master)](https://dev.azure.com/knotx/Knotx/_build/latest?definitionId=14&branchName=master)

[![Gradle Status](https://gradleupdate.appspot.com/Knotx/knotx-gradle-plugins/status.svg)](https://gradleupdate.appspot.com/Knotx/knotx-gradle-plugins/status)

# knotx-gradle-plugins

Gradle plugins that help manage Knot.x modules builds.

## Plugins

### Distribution Plugin

Distribution Plugin identifies good practices on how to create a custom `Knot.x` distribution. This is a set of tasks that you can use when starting a new project, regardless of whereter it is Docker-based or not.

#### How to use

Declare the `plugins` section in your build script

```kotlin

plugins {

    id("io.knotx.distribution")

}

```

Then point to the root directory with the `Knot.x` configuration, setting the `knotx.conf` property in `gradle.properties`. E.g:

```conf

knotx.conf=src/main/packaging

```

Now you can configure `clean` and `build` tasks with Knot.x Distribution Plugin tasks (see their descriptions below):

```kotlin

tasks.named("build") { finalizedBy("assembleCustomDistribution") }

tasks.named("clean") { dependsOn("cleanDistribution") }

```

All your custom modules can be easily configured with the `dist` configuration, e.g:

```kotlin

dependencies {

    subprojects.forEach { "dist"(project(":${it.name}")) }

}

```

#### Available tasks

 - `overwriteCustomFiles` - copies/replaces files from the directory specified in the `knotx.conf` property to `build/out/knotx`. In addition, all dependencies form `dist` are copied to  `build/out/lib`.  

 - `downloadBaseDistribution` - downloads the [Knot.x Stack](https://github.com/Knotx/knotx-stack) and extracts it into the `build/out` directory

 - `assembleCustomDistribution` - combines the two above tasks and creates a full `Knot.x` distribution with all your custom dependencies. Distribution available in the `build/distribution` directory 

#### Examples

##### ZIPed distribution 

Check the [Getting Started with Knot.x Stack](https://github.com/Knotx/knotx-example-project/tree/master/getting-started) example project as a reference.

##### Docker distribution

Check [Knot.x Starter Kit](https://github.com/Knotx/knotx-starter-kit) as a reference.

 

 ## Local development and testing

In order to properly develop and test new version of this plugin, you will need a working project on which tests will be carried out.

When you have it prepared, add the following snippet at the beginning of the target project's `settings.gradle.kts` file:

```kotlin

pluginManagement {

    repositories {

        mavenLocal()

        gradlePluginPortal()

    }

}

```

After that, you can push the new version of `knotx-gradle-plugins` to your local Maven repository (via Gradle's `publishToMavenLocal` task),

and verify that the added functionality works as expected.

## Development

Run `./gradlew clean build` to build the project.