Skip to content

Commit e28cb7a

Browse files
authored
Add install instructions (#60)
1 parent 5f54cb1 commit e28cb7a

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.adoc

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ ifdef::env-github[]
1212
:tip-caption: :bulb:
1313
:warning-caption: :warning:
1414
endif::[]
15+
:mvn-plugin-ver: 1.2.0.1
1516

1617
image:https://img.shields.io/github/license/Axway-API-Management-Plus/apigw-maven-plugin?style=plastic[]
1718
image:https://img.shields.io/github/v/release/Axway-API-Management-Plus/apigw-maven-plugin?style=plastic[]
@@ -105,6 +106,42 @@ The plugin supports three kind of API Gateway projects:
105106
* Check of certificate expiration.
106107
* Deploy projects to gateway via plugin.
107108

109+
== Installation
110+
111+
=== Build & Install
112+
113+
[source,shell]
114+
----
115+
git clone https://github.com/Axway-API-Management-Plus/apigw-maven-plugin.git
116+
cd apigw-maven-plugin
117+
mvn clean install
118+
----
119+
120+
=== Download & Install
121+
122+
To download and install the plugin you could use the following script:
123+
124+
.install-apigw-maven-plugin.sh
125+
[source,shell,subs="verbatim,attributes"]
126+
----
127+
#!/bin/bash
128+
set -euo pipefail
129+
130+
APIGW_MVN_PLUGIN_VER={mvn-plugin-ver}
131+
132+
APIGW_MVN_PLUGIN="apigw-maven-plugin-$\{APIGW_MVN_PLUGIN_VER}"
133+
APIGW_MVN_PLUGIN_JAR="$\{APIGW_MVN_PLUGIN}.jar"
134+
APIGW_MVN_PLUGIN_POM="$\{APIGW_MVN_PLUGIN}.pom"
135+
136+
GITHUB_RELEASES="https://github.com/Axway-API-Management-Plus/apigw-maven-plugin/releases/download/v${APIGW_MVN_PLUGIN_VER}"
137+
138+
# Download artifacts
139+
wget -nv "$\{GITHUB_RELEASES}/$\{APIGW_MVN_PLUGIN_JAR}" -O "${APIGW_MVN_PLUGIN_JAR}"
140+
wget -nv "$\{GITHUB_RELEASES}/$\{APIGW_MVN_PLUGIN_POM}" -O "${APIGW_MVN_PLUGIN_POM}"
141+
142+
# Install plugin
143+
mvn install:install-file -Dfile="$\{APIGW_MVN_PLUGIN_JAR}" -DpomFile="$\{APIGW_MVN_PLUGIN_POM}"
144+
----
108145

109146
== More to Read
110147

0 commit comments

Comments
 (0)