Skip to content

Commit f4c37a2

Browse files
committed
Adding docs on how to build/test the plugin
1 parent b9ab479 commit f4c37a2

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,5 +114,27 @@ openApi {
114114
```
115115

116116
# Building the plugin
117-
118-
TODO
117+
1. Clone the repo `[email protected]:springdoc/springdoc-openapi-gradle-plugin.git`
118+
2. Build and publish the plugin into your local maven repository by running the following
119+
```
120+
./gradlew clean pTML
121+
```
122+
123+
# Testing the plugin
124+
1. Create a new spring boot application or use an existing spring boot app and follow the `How To Use` section above to configure this plugin.
125+
2. Update the version for the plugin to match the current version found in `build.gradle.kts`
126+
127+
```
128+
id("org.springdoc.openapi-gradle-plugin") version "1.33.0-SNAPSHOT"
129+
```
130+
131+
3. Add the following to the spring boot apps `settings.gradle`
132+
133+
```
134+
pluginManagement {
135+
repositories {
136+
mavenLocal()
137+
gradlePluginPortal()
138+
}
139+
}
140+
```

0 commit comments

Comments
 (0)