Merge branch 'malowe/master/3' into 'master'

Updates for docs + initial build script

See merge request eclipsefdn/webdev/eclipsefdn-api-common!2

.gitlab-ci.yml

-# Build JAVA applications using Apache Maven (http://maven.apache.org)
-# For docker image tags see https://hub.docker.com/_/maven/
-#
-# For general lifecycle information see https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html
-
-# This template will build and test your projects
-# * Caches downloaded dependencies and plugins between invocation.
-# * Verify but don't deploy merge requests.
-# * Deploy built artifacts from master branch only.
-
-variables:
-  # This will suppress any download for dependencies and plugins or upload messages which would clutter the console log.
-  # `showDateTime` will show the passed time in milliseconds. You need to specify `--batch-mode` to make this work.
-  MAVEN_OPTS: "-Dhttps.protocols=TLSv1.2 -Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository -Djava.awt.headless=true"
-  # As of Maven 3.3.0 instead of this you may define these options in `.mvn/maven.config` so the same config is used
-  # when running from the command line.
-  # `installAtEnd` and `deployAtEnd` are only effective with recent version of the corresponding plugins.
-  MAVEN_CLI_OPTS: "--batch-mode --errors --fail-at-end --show-version -DinstallAtEnd=true -DdeployAtEnd=true"
-
-# This template uses jdk8 for verifying and deploying images
-image: maven:3.3.9-jdk-8
-
-# Cache downloaded dependencies and plugins between builds.
-# To keep cache across branches add 'key: "$CI_JOB_NAME"'
-cache:
-  paths:
-    - .m2/repository
-
-# For merge requests do not `deploy` but only run `verify`.
-# See https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html
-.verify: &verify
-  stage: test
-  script:
-    - 'mvn $MAVEN_CLI_OPTS verify -Dconfig.secret.path=config/sample.secret.properties'
-  except:
-    - master
-
-# Verify merge requests using JDK8
-verify:jdk8:
-  <<: *verify
-
-# To deploy packages from CI, create a ci_settings.xml file
-# For deploying packages to GitLab's Maven Repository: See https://docs.gitlab.com/ee/user/project/packages/maven_repository.html#creating-maven-packages-with-gitlab-cicd for more details.
-# Please note: The GitLab Maven Repository is currently only available in GitLab Premium / Ultimate.
-# For `master` branch run `mvn deploy` automatically.
-deploy:jdk8:
-  stage: deploy
-  script:
-    - if [ ! -f ci_settings.xml ];
-        then echo "CI settings missing\! If deploying to GitLab Maven Repository, please see https://docs.gitlab.com/ee/user/project/packages/maven_repository.html#creating-maven-packages-with-gitlab-cicd for instructions.";
-      fi
-    - 'mvn $MAVEN_CLI_OPTS deploy -s ci_settings.xml'
-  only:
-    - master

CODE_OF_CONDUCT.md

+# Community Code of Conduct
+
+**Version 1.1 
+October 21, 2019**
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at codeofconduct@eclipse.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
\ No newline at end of file

CONTRIBUTING.md

+# Contributing to eclipsefdn-api-commons
+
+Thanks for your interest in this project.
+
+## Project description
+
+eclipsefdn-api-commons is a project to centralize common code used within Quarkus-based applications (such as persistence, and interacting with the current request) 
+
+* https://gitlab.eclipse.org/eclipsefdn/webdev/eclipsefdn-api-common
+
+## Developer resources
+
+The project maintains the following source code repositories
+
+* https://gitlab.eclipse.org/eclipsefdn/webdev/eclipsefdn-api-common
+
+## Eclipse Contributor Agreement
+
+Before your contribution can be accepted by the project team contributors must
+electronically sign the Eclipse Contributor Agreement (ECA).
+
+* http://www.eclipse.org/legal/ECA.php
+
+Commits that are provided by non-committers must have a Signed-off-by field in
+the footer indicating that the author is aware of the terms by which the
+contribution has been provided to the project. The non-committer must
+additionally have an Eclipse Foundation account and must have a signed Eclipse
+Contributor Agreement (ECA) on file.
+
+For more information, please see the Eclipse Committer Handbook:
+https://www.eclipse.org/projects/handbook/#resources-commit
+
+## Contact
+
+Contact the Eclipse Foundation Webdev team via webdev@eclipse-foundation.org.

Jenkinsfile

+  @Library('common-shared') _
+
+  pipeline {
+    agent {
+      kubernetes {
+        label 'buildpack-agent'
+        yaml '''
+        apiVersion: v1
+        kind: Pod
+        spec:
+          containers:
+          - name: buildpack
+            image: buildpack-deps:stable
+            command:
+            - cat
+            tty: true
+            resources:
+              limits:
+                memory: "2Gi"
+                cpu: "1"
+              requests:
+                memory: "2Gi"
+                cpu: "1"
+            volumeMounts:
+            - name: tmp
+              mountPath: /tmp
+          - name: jnlp
+            resources:
+              limits:
+                memory: "2Gi"
+                cpu: "1"
+              requests:
+                memory: "2Gi"
+                cpu: "1"
+            volumeMounts:
+            - name: mvnw
+              mountPath: /home/jenkins/.m2/wrapper
+              readOnly: false
+            - name: m2-repo
+              mountPath: /home/jenkins/.m2/repository
+            - name: settings-xml
+              mountPath: /home/jenkins/.m2/settings.xml
+              subPath: settings.xml
+              readOnly: true
+            - name: tmp
+              mountPath: /tmp
+          volumes:
+          - name: mvnw
+            emptyDir: {}
+          - name: m2-repo
+            emptyDir: {}
+          - name: tmp
+            emptyDir: {}
+          - name: settings-xml
+            secret:
+              secretName: m2-secret-dir
+              items:
+              - key: settings.xml
+                path: settings.xml
+        '''
+      }
+    }
+
+    environment {
+      APP_NAME = 'geoip-rest-api'
+      NAMESPACE = 'foundation-internal-webdev-apps'
+      IMAGE_NAME = 'eclipsefdn/geoip-rest-api'
+      CONTAINER_NAME = 'app'
+      ENVIRONMENT = sh(
+        script: """
+          if [ "${env.BRANCH_NAME}" = "master" ]; then
+            printf "production"
+          else
+            printf "${env.BRANCH_NAME}"
+          fi
+        """,
+        returnStdout: true
+      )
+      TAG_NAME = sh(
+        script: """
+          GIT_COMMIT_SHORT=\$(git rev-parse --short ${env.GIT_COMMIT})
+          if [ "${env.ENVIRONMENT}" = "" ]; then
+            printf \${GIT_COMMIT_SHORT}-${env.BUILD_NUMBER}
+          else
+            printf ${env.ENVIRONMENT}-\${GIT_COMMIT_SHORT}-${env.BUILD_NUMBER}
+          fi
+        """,
+        returnStdout: true
+      )
+    }
+
+    options {
+      buildDiscarder(logRotator(numToKeepStr: '10'))
+    }
+
+    triggers { 
+      // build once a week to keep up with parents images updates
+      cron('H H * * H') 
+    }
+
+    stages {
+      stage('Build Java code') {
+        steps {
+          sh './mvnw -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn --batch-mode package'
+          stash includes: 'target/', name: 'target'
+        }
+      }
+
+      stage('Push package image to Nexus') {
+        agent {
+          label 'docker-build'
+        }
+        when {
+          anyOf {
+            environment name: 'ENVIRONMENT', value: 'production'
+          }
+        }
+        steps {
+          sh '''
+            sh './mvnw -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn --batch-mode clean deploy'
+          '''
+        }
+      }
+    }
+
+    post {
+      always {
+        deleteDir() /* clean up workspace */
+        sendNotifications currentBuild
+      }
+    }
+  }

NOTICE.md

+# Notices for react-eclipsefdn-members
+
+This content is produced and maintained by the Eclipse Foundation. Trademarks are the property of their respective owners.
+
+* Project home: https://gitlab.eclipse.org/eclipsefdn/webdev/eclipsefdn-api-common
+
+## Trademarks
+
+* Eclipse® is a Trademark of the Eclipse Foundation, Inc.
+* Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.
+
+## Copyright
+
+All content is the property of the respective authors or their employers. For
+more information regarding authorship of content, please consult the listed
+source code repository logs.
+
+## Declared Project Licenses
+
+This program and the accompanying materials are made available under the terms
+of the Eclipse Public License v. 2.0 which is available at
+http://www.eclipse.org/legal/epl-2.0.
+
+SPDX-License-Identifier: EPL-2.0
+
+## Source Code
+
+The project maintains the following source code repositories:
+
+* https://gitlab.eclipse.org/eclipsefdn/webdev/eclipsefdn-api-common
+
+## Third-party Content
+
+### Quarkus (^1.9.2)
+
+* License: The Apache-2.0 License (APL-2.0)
+
+### Apache commons-lang3 (^3.9)
+
+* License: The Apache-2.0 License (APL-2.0)
+
+### Lucene Core (8.5.2)
+
+* License: The Apache-2.0 License (APL-2.0)
+
+### Lucene Queries (8.5.2)
+
+* License: The Apache-2.0 License (APL-2.0)
+
+### Apache Solr Solrj (8.4.1)
+
+* License: The Apache-2.0 License (APL-2.0)
+
+### JBoss Log Manager (2.1.14.Final)
+
+* License: The Apache-2.0 License (APL-2.0)

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.eclipsefoundation</groupId>
 	<artifactId>quarkus-commons</artifactId>
-  <name>Java SDK Commons</name>
+	<name>Java SDK Commons</name>
 	<version>0.1-BETA</version>
 	<packaging>pom</packaging>
 	<properties>
@@ -14,15 +14,16 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<maven.compiler.source>11</maven.compiler.source>
 		<maven.compiler.target>11</maven.compiler.target>
-    <maven.compiler.parameters>true</maven.compiler.parameters>
-    <compiler-plugin.version>3.8.1</compiler-plugin.version>
-		<sonar.sources>src/main</sonar.sources>
-		<sonar.tests>src/test</sonar.tests>
-		<sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
-		<sonar.dynamicAnalysis>reuseReports</sonar.dynamicAnalysis>
-		<sonar.jacoco.reportPaths>${project.build.directory}/jacoco-report</sonar.jacoco.reportPaths>
-		<sonar.junit.reportPath>${project.build.directory}/surefire-reports</sonar.junit.reportPath>
+		<maven.compiler.parameters>true</maven.compiler.parameters>
+		<compiler-plugin.version>3.8.1</compiler-plugin.version>
 	</properties>
+	<distributionManagement>
+		<repository>
+			<id>nexus</id>
+			<name>Nexus Staging Repo</name>
+			<url>https://repo.eclipse.org/nexus/service/local/staging/deploy/eclipsefdn/</url>
+		</repository>
+	</distributionManagement>
 	<dependencyManagement>
 		<dependencies>
 			<dependency>
@@ -36,8 +37,8 @@
 	</dependencyManagement>
 	<modules>
 		<module>core</module>
-    <module>persistence</module>
-    <module>search</module>
+		<module>persistence</module>
+		<module>search</module>
 	</modules>
 	<build>
 		<plugins>
@@ -104,22 +105,5 @@
 				</property>
 			</activation>
 		</profile>
-		<profile>
-			<id>sonar-dev</id>
-			<build>
-				<plugins>
-					<plugin>
-						<groupId>org.sonarsource.scanner.maven</groupId>
-						<artifactId>sonar-maven-plugin</artifactId>
-						<version>3.7.0.1746</version>
-					</plugin>
-				</plugins>
-			</build>
-			<properties>
-				<sonar.host.url>https://sonarqube.dev.docker</sonar.host.url>
-				<sonar.login>admin</sonar.login>
-				<sonar.password>admin</sonar.password>
-			</properties>
-		</profile>
 	</profiles>
 </project>