summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabio Busatto <fabio@gitlab.com>2017-08-03 09:13:08 +0000
committerFabio Busatto <fabio@gitlab.com>2017-08-03 09:13:08 +0000
commit1379f0e3826b953e8f67a427b759abb7af88df80 (patch)
tree4be90005299fcff538ed55bf869124f94a9d7d00
parent40dfddd4077da4d594bd9e8956e1fcb1c99434e6 (diff)
downloadgitlab-ce-1379f0e3826b953e8f67a427b759abb7af88df80.tar.gz
Update index.md
-rw-r--r--doc/articles/how_to_use_gitlab_ci_to_deploy_maven_projects_to_artifactory/index.md28
1 files changed, 15 insertions, 13 deletions
diff --git a/doc/articles/how_to_use_gitlab_ci_to_deploy_maven_projects_to_artifactory/index.md b/doc/articles/how_to_use_gitlab_ci_to_deploy_maven_projects_to_artifactory/index.md
index 2dba8688a24..2a8e9ea2717 100644
--- a/doc/articles/how_to_use_gitlab_ci_to_deploy_maven_projects_to_artifactory/index.md
+++ b/doc/articles/how_to_use_gitlab_ci_to_deploy_maven_projects_to_artifactory/index.md
@@ -14,7 +14,7 @@ You'll create two different projects:
- `simple-maven-dep`: the app built and deployed to Artifactory (available at https://gitlab.com/gitlab-examples/maven/simple-maven-dep)
- `simple-maven-app`: the app using the previous one as a dependency (available at https://gitlab.com/gitlab-examples/maven/simple-maven-app)
-We assume that you already have a GitLab account on [GitLab.com](https://gitlab.com/), and that you know the basic usage of GitLab CI/CD.
+We assume that you already have a GitLab account on [GitLab.com](https://gitlab.com/), and that you know the basic usage of Git and GitLab CI/CD.
We also assume that an Artifactory instance is available and reachable from the internet, and that you have valid credentials to deploy on it.
## Create the simple Maven dependency
@@ -41,6 +41,7 @@ The application is ready to use, but you need some additional steps to deploy it
2. from the main screen, click on the `libs-release-local` item in the **Set Me Up** panel
3. copy to clipboard the configuration snippet under the **Deploy** paragraph
4. change the `url` value in order to have it configurable via secret variables
+5. copy the snippet in the `pom.xml` file for your project, just after the `dependencies` section
The snippet should look like this:
@@ -54,14 +55,14 @@ The snippet should look like this:
</distributionManagement>
```
-Now copy the snippet in the `pom.xml` file for your project, just after the `dependencies` section. Easy!
-
Another step you need to do before you can deploy the dependency to Artifactory is to configure authentication data.
It is a simple task, but Maven requires it to stay in a file called `settings.xml` that has to be in the `.m2` subfolder in the user's homedir.
-Since you want to use GitLab Runner to automatically deploy the application, you should create the file in the project home
-and set a command line parameter in `.gitlab-ci.yml` to use the custom location instead of the default one.
-For this scope, create a folder called `.m2` in the root of the repo. You must create a file named `settings.xml` there, and copy the following text into it.
+Since you want to use GitLab Runner to automatically deploy the application, you should create the file in the project home
+and set a command line parameter in `.gitlab-ci.yml` to use the custom location instead of the default one:
+1. create a folder called `.m2` in the root of the repo
+2. create a file called `settings.xml` in the `.m2` folder
+3. copy the following content into `settings.xml`
```xml
<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"
@@ -79,8 +80,6 @@ For this scope, create a folder called `.m2` in the root of the repo. You must c
>**Note**:
`username` and `password` will be replaced by the correct values using secret variables.
-Remember to commit all the changes to the repo!
-
### Configure GitLab CI/CD for `simple-maven-dep`
Now it's time we set up GitLab CI/CD to automatically build, test and deploy the dependency!
@@ -157,9 +156,14 @@ Now that you have the dependency available on Artifactory, you want to use it!
Create another application by cloning the one you can find at `https://gitlab.com/gitlab-examples/maven/simple-maven-app.git`.
If you look at the `src/main/java/com/example/app/App.java` file you can see that it imports the `com.example.dep.Dep` class and calls the `hello` method passing `GitLab` as a parameter.
-Since Maven doesn't know how to resolve the dependency, you need to modify the configuration.
-Go back to Artifactory, and browse the `libs-release-local` repository selecting the `simple-maven-dep-1.0.jar` file.
-In the **Dependency Declaration** section of the main panel you can copy the configuration snippet:
+Since Maven doesn't know how to resolve the dependency, you need to modify the configuration:
+1. go back to Artifactory
+2. browse the `libs-release-local` repository
+3. select the `simple-maven-dep-1.0.jar` file
+4. find the configuration snippet from the **Dependency Declaration** section of the main panel
+5. copy the snippet in the `dependencies` section of the `pom.xml` file
+
+The snippet should look like this:
```xml
<dependency>
@@ -169,8 +173,6 @@ In the **Dependency Declaration** section of the main panel you can copy the con
</dependency>
```
-Copy this in the `dependencies` section of the `pom.xml` file.
-
### Configure the Artifactory repository location
At this point you defined the dependency for the application, but you still miss where you can find the required files.