Initial commit

.github/dependabot.yml

@@ -0,0 +1,25 @@
+version: 2
+registries:
+  maven-central:
+    type: "maven-repository"
+    url: "https://repo1.maven.org/maven2"
+    username: ""
+    password: ""
+  inrupt-internal:
+    type: "maven-repository"
+    url: "https://download.software.inrupt.com/basic/internal/maven"
+    username: ${{secrets.CLOUDSMITH_USERNAME}}
+    password: ${{secrets.CLOUDSMITH_TOKEN}}
+updates:
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    registries:
+      - "maven-central"
+      - "inrupt-internal"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+

.github/maven-settings.xml

@@ -0,0 +1,24 @@
+<settings>
+  <servers>
+    <server>
+      <id>inrupt</id>
+      <username>${env.MAVEN_REPO_USERNAME}</username>
+      <password>${env.MAVEN_REPO_TOKEN}</password>
+    </server>
+    <server>
+      <id>inrupt-staging</id>
+      <username>${env.MAVEN_REPO_USERNAME}</username>
+      <password>${env.MAVEN_REPO_TOKEN}</password>
+    </server>
+    <server>
+      <id>inrupt-development</id>
+      <username>${env.MAVEN_REPO_USERNAME}</username>
+      <password>${env.MAVEN_REPO_TOKEN}</password>
+    </server>
+    <server>
+      <id>inrupt-internal</id>
+      <username>${env.MAVEN_REPO_USERNAME}</username>
+      <password>${env.MAVEN_REPO_TOKEN}</password>
+    </server>
+  </servers>
+</settings>

.github/workflows/cd-config.yml

@@ -0,0 +1,55 @@
+# TODO: Rename
+name: ESS CD
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      # TODO: Replace PROJECT
+      - inrupt-PROJECT-[0-9]+.[0-9]+.[0-9]+
+
+jobs:
+  publish:
+    name: Build and publish to Cloudsmith
+    runs-on: ubuntu-latest
+    env:
+      MAVEN_REPO_USERNAME: ${{ secrets.CLOUDSMITH_USERNAME }}
+      MAVEN_REPO_TOKEN: ${{ secrets.CLOUDSMITH_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: 11
+          cache: 'maven'
+
+      - name: Set up maven configuration
+        run: cp .github/maven-settings.xml $HOME/.m2/settings.xml
+
+      - name: Build the code with Maven
+        run: ./mvnw -B -ntp clean install
+
+      - name: Configure container registry
+        run: echo "QUARKUS_CONTAINER_IMAGE_REGISTRY=docker.stage.software.inrupt.com" >> $GITHUB_ENV
+        # TODO: Replace PROJECT
+        if: startsWith(github.ref, 'refs/tags/inrupt-PROJECT-')
+
+      - name: Configure container registry
+        run: echo "QUARKUS_CONTAINER_IMAGE_REGISTRY=docker.dev.software.inrupt.com" >> $GITHUB_ENV
+        if: github.ref == 'refs/heads/main'
+
+      - name: Login to docker repository
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.QUARKUS_CONTAINER_IMAGE_REGISTRY }}
+          username: ${{ secrets.CLOUDSMITH_USERNAME }}
+          password: ${{ secrets.CLOUDSMITH_TOKEN }}
+
+      # TODO: Replace NAME and enable
+      #- name: Publish NAME app
+      #  run: ./mvnw -pl app/NAME package -Ppublish-app
+

.github/workflows/ci-config.yml

@@ -0,0 +1,36 @@
+# TODO: Rename
+name: ESS CI
+
+on:
+  # Build pull requests for any branch
+  pull_request: { }
+
+jobs:
+  build:
+    name: Java environment
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: [ 11, 17 ]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      # Set up the Java environment
+      - name: Set up JDK ${{ matrix.java }}
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java }}
+          cache: 'maven'
+
+      # Set up the Maven configuration
+      - name: Set up maven configuration
+        run: cp .github/maven-settings.xml $HOME/.m2/settings.xml
+
+      # Run the actual build
+      - name: Build the code with Maven
+        run: mvn -B -ntp clean install javadoc:javadoc
+        env:
+          MAVEN_REPO_USERNAME: ${{ secrets.CLOUDSMITH_USERNAME }}
+          MAVEN_REPO_TOKEN: ${{ secrets.CLOUDSMITH_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+target/

.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2007-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import java.net.*;
+import java.io.*;
+import java.nio.channels.*;
+import java.util.Properties;
+
+public class MavenWrapperDownloader {
+
+    private static final String WRAPPER_VERSION = "0.5.6";
+    /**
+     * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
+     */
+    private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
+        + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
+
+    /**
+     * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
+     * use instead of the default one.
+     */
+    private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
+            ".mvn/wrapper/maven-wrapper.properties";
+
+    /**
+     * Path where the maven-wrapper.jar will be saved to.
+     */
+    private static final String MAVEN_WRAPPER_JAR_PATH =
+            ".mvn/wrapper/maven-wrapper.jar";
+
+    /**
+     * Name of the property which should be used to override the default download url for the wrapper.
+     */
+    private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
+
+    public static void main(String args[]) {
+        System.out.println("- Downloader started");
+        File baseDirectory = new File(args[0]);
+        System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
+
+        // If the maven-wrapper.properties exists, read it and check if it contains a custom
+        // wrapperUrl parameter.
+        File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
+        String url = DEFAULT_DOWNLOAD_URL;
+        if(mavenWrapperPropertyFile.exists()) {
+            FileInputStream mavenWrapperPropertyFileInputStream = null;
+            try {
+                mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
+                Properties mavenWrapperProperties = new Properties();
+                mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
+                url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
+            } catch (IOException e) {
+                System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
+            } finally {
+                try {
+                    if(mavenWrapperPropertyFileInputStream != null) {
+                        mavenWrapperPropertyFileInputStream.close();
+                    }
+                } catch (IOException e) {
+                    // Ignore ...
+                }
+            }
+        }
+        System.out.println("- Downloading from: " + url);
+
+        File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
+        if(!outputFile.getParentFile().exists()) {
+            if(!outputFile.getParentFile().mkdirs()) {
+                System.out.println(
+                        "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
+            }
+        }
+        System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
+        try {
+            downloadFileFromURL(url, outputFile);
+            System.out.println("Done");
+            System.exit(0);
+        } catch (Throwable e) {
+            System.out.println("- Error downloading");
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private static void downloadFileFromURL(String urlString, File destination) throws Exception {
+        if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+            String username = System.getenv("MVNW_USERNAME");
+            char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+            Authenticator.setDefault(new Authenticator() {
+                @Override
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication(username, password);
+                }
+            });
+        }
+        URL website = new URL(urlString);
+        ReadableByteChannel rbc;
+        rbc = Channels.newChannel(website.openStream());
+        FileOutputStream fos = new FileOutputStream(destination);
+        fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+        fos.close();
+        rbc.close();
+    }
+
+}

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,2 @@
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.1/apache-maven-3.8.1-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar

README.md

@@ -0,0 +1,27 @@
+# Inrupt Template TODO: Replace with a relevant README
+
+This template repository provides much of the common structure used by ESS projects.
+
+Once a new project is built from this template a number of changes are required.
+
+
+1. [GitHub Actions secrets](../../settings/secrets/actions)
+   1. Add two sets of secrets:
+      - `CLOUDSMITH_TOKEN`
+      - `CLOUDSMITH_USERNAME`
+2. [GitHub Dependabot secrets](../../settings/secrets/dependabot)
+   1. Add two sets of secrets:
+      - `CLOUDSMITH_TOKEN`
+      - `CLOUDSMITH_USERNAME`
+3. [POM](./pom.xml)
+   1. Adjust the `<scm>` section (near the bottom).
+4. [CI](./.github/workflows/ci-config.yml)
+   1. Set the workflow `name` (at the top) to something more informative.
+5. [CD](./.github/workflows/cd-config.yml)
+   1. Set the workflow `name` (at the top) to something more informative.
+   2. Uncomment and adjust the final step of the build job.
+   3. Adjust the release tag trigger pattern to match the project name.
+6. [Project Site](./src/site/site.xml)
+   1. Adjust the PROJECT name with an appropriate value.
+7. [README](./README.md) (this file)
+   1. Replace with something more relevant to your project.