Browse Source

Add maven docs

Joe Ferguson 11 years ago
parent
commit
e2782b8942
6 changed files with 120 additions and 0 deletions
  1. 1 0
      maven/README-short.txt
  2. 79 0
      maven/README.md
  3. 37 0
      maven/content.md
  4. 2 0
      maven/license.md
  5. BIN
      maven/logo.png
  6. 1 0
      update.sh

+ 1 - 0
maven/README-short.txt

@@ -0,0 +1 @@
+Apache Maven is a software project management and comprehension tool.

+ 79 - 0
maven/README.md

@@ -0,0 +1,79 @@
+# Supported tags and respective `Dockerfile` links
+
+- [`3.2-jdk-6`, `3-jdk-6` (*jdk-6/Dockerfile*)](https://github.com/carlossg/docker-maven/blob/2f22e2b/jdk-6/Dockerfile)
+- [`3.2-jdk-6-onbuild`, `3-jdk-6-onbuild` (*jdk-6/onbuild/Dockerfile*)](https://github.com/carlossg/docker-maven/blob/2f22e2b/jdk-6/onbuild/Dockerfile)
+- [`3.2-jdk-7`, `3-jdk-7`, `3.2`, `3`, `latest` (*jdk-7/Dockerfile*)](https://github.com/carlossg/docker-maven/blob/2f22e2b/jdk-7/Dockerfile)
+- [`3.2-jdk-7-onbuild`, `3-jdk-7-onbuild`, `3.2-onbuild`, `3-onbuild`, `latest-onbuild` (*jdk-7/onbuild/Dockerfile*)](https://github.com/carlossg/docker-maven/blob/2f22e2b/jdk-7/onbuild/Dockerfile)
+- [`3.2-jdk-8`, `3-jdk-8` (*jdk-8/Dockerfile*)](https://github.com/carlossg/docker-maven/blob/2f22e2b/jdk-8/Dockerfile)
+- [`3.2-jdk-8-onbuild`, `3-jdk-8-onbuild` (*jdk-8/onbuild/Dockerfile*)](https://github.com/carlossg/docker-maven/blob/2f22e2b/jdk-8/onbuild/Dockerfile)
+
+For more information about this image and its history, please see the [relevant
+manifest file
+(`library/maven`)](https://github.com/docker-library/official-images/blob/master/library/maven)
+in the [`docker-library/official-images` GitHub
+repo](https://github.com/docker-library/official-images).
+
+# What is Maven?
+
+[Apache Maven](http://maven.apache.org) is a software project management and
+comprehension tool.
+Based on the concept of a project object model (POM),
+Maven can manage a project's build,
+reporting and documentation from a central piece of information.
+
+![logo](https://raw.githubusercontent.com/docker-library/docs/master/maven/logo.png)
+
+# How to use this image
+
+## Create a Dockerfile in your Maven project
+
+    FROM maven:3.2-jdk-7-onbuild
+    CMD ["do-something-with-built-packages"]
+
+Put this file in the root of your project, next to the pom.xml.
+
+This image includes multiple ONBUILD triggers which should be all you need to
+bootstrap.
+The build will `COPY . /usr/src/app` and `RUN mvn install`.
+
+You can then build and run the image:
+
+    docker build -t my-maven .
+    docker run -it --name my-maven-script my-maven
+
+
+## Run a single Maven command
+
+For many simple projects, you may find it inconvenient to write a complete
+`Dockerfile`.
+In such cases, you can run a Maven project by using the Maven Docker image
+directly, passing a Maven command to `docker run`:
+
+    docker run -it --rm --name my-maven-project -v "$(pwd)":/usr/src/mymaven -w /usr/src/mymaven maven:3.2-jdk-7 mvn clean install
+
+# License
+
+View [license information](https://www.apache.org/licenses/) for the software
+contained in this image.
+
+# User Feedback
+
+## Issues
+
+If you have any problems with or questions about this image, please contact us
+ through a [GitHub issue](https://github.com/carlossg/docker-maven/issues).
+
+You can also reach many of the official image maintainers via the
+`#docker-library` IRC channel on [Freenode](https://freenode.net).
+
+## Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small;
+we are always thrilled to receive pull requests, and do our best to process them
+as fast as we can.
+
+Before you start to code, we recommend discussing your plans 
+through a [GitHub issue](https://github.com/carlossg/docker-maven/issues), especially for more ambitious
+contributions. This gives other contributors a chance to point you in the right
+direction, give you feedback on your design, and help you find out if someone
+else is working on the same thing.

+ 37 - 0
maven/content.md

@@ -0,0 +1,37 @@
+# What is Maven?
+
+[Apache Maven](http://maven.apache.org) is a software project management and
+comprehension tool.
+Based on the concept of a project object model (POM),
+Maven can manage a project's build,
+reporting and documentation from a central piece of information.
+
+%%LOGO%%
+
+# How to use this image
+
+## Create a Dockerfile in your Maven project
+
+    FROM maven:3.2-jdk-7-onbuild
+    CMD ["do-something-with-built-packages"]
+
+Put this file in the root of your project, next to the pom.xml.
+
+This image includes multiple ONBUILD triggers which should be all you need to
+bootstrap.
+The build will `COPY . /usr/src/app` and `RUN mvn install`.
+
+You can then build and run the image:
+
+    docker build -t my-maven .
+    docker run -it --name my-maven-script my-maven
+
+
+## Run a single Maven command
+
+For many simple projects, you may find it inconvenient to write a complete
+`Dockerfile`.
+In such cases, you can run a Maven project by using the Maven Docker image
+directly, passing a Maven command to `docker run`:
+
+    docker run -it --rm --name my-maven-project -v "$(pwd)":/usr/src/mymaven -w /usr/src/mymaven maven:3.2-jdk-7 mvn clean install

+ 2 - 0
maven/license.md

@@ -0,0 +1,2 @@
+View [license information](https://www.apache.org/licenses/) for the software
+contained in this image.

BIN
maven/logo.png


+ 1 - 0
update.sh

@@ -34,6 +34,7 @@ declare -A otherRepos=(
 	[jenkins]='https://github.com/cloudbees/jenkins-ci.org-docker'
 	[jruby]='https://github.com/cpuguy83/docker-jruby'
 	[mageia]='https://github.com/juanluisbaptiste/docker-brew-mageia'
+	[maven]='https://github.com/carlossg/docker-maven'
 	[mono]='https://github.com/mono/docker'
 	[neurodebian]='https://github.com/neurodebian/dockerfiles'
 	[nginx]='https://github.com/nginxinc/docker-nginx'