1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# KAU :gradle-plugin
> Plugin helper for KAU
KAU holds quite a big collection of projects, with the intent on making it easy to reuse complex features, and also to update.
This plugin aims to help maintain version updates straight from the source, and also adds on a few nice functions.
As a note, this is located under `buildSrc` as it is automatically included when building KAU.
Everything here is used when generating the library, so it's always tested.
## Contents
* [Versions](#versions)
* [Plugins](#plugins)
* [Dependencies](#dependencies)
* [Changelog Generator](#changelog-generator)
## Usage
Firstly, add KAU to the buildscript:
```gradle
buildscript {
repositories {
...
maven { url "https://jitpack.io" }
}
dependencies {
...
classpath "ca.allanwang:kau:${KAU}"
}
}
```
Then where necessary, apply the plugin using
```gradle
apply plugin: 'ca.allanwang.kau'
```
# Versions
> [Versions.groovy](/buildSrc/src/main/groovy/ca/allanwang/kau/Versions.groovy)
Contains the version code for any external library used in KAU.
You are free to use the values through `kau.[tagName]`.
As an example, AppCompat is imported in KAU using
```gradle
api "androidx.appcompat:appcompat:${kau.appcompat}"
```
# Plugins
> [Plugins.groovy](/buildSrc/src/main/groovy/ca/allanwang/kau/Plugins.groovy)
Unfortunately, it seems like you can't use the plugin directly in the buildscript, so this is mainly internal.
The plugins data, found using `kauPlugins.[tagName]` contains a collection of useful plugin classpaths.
The versions are taken from `Versions.groovy`, so it is always in sync.
# Dependencies
> [Dependencies.groovy](/buildSrc/src/main/groovy/ca/allanwang/kau/Dependencies.groovy)
Contains the dependency string for common libraries.
You are free to use the values through `kauDependency.[tagName]`.
As an example, adding junit can be done through
```gradle
testImplementation kauDependency.junit
```
# Changelog Generator
In conjunction with [core](/core#changelog-xml),
the xml changelog can be converted to markdown.
To allow for compilation per build, add your own task:
```gradle
task generateChangelogMd() {
kauChangelog.generate([inputPath], [outputPath])
}
```
The wrapper allows for the generator to be called automatically with each build.
|
