diff --git a/dist/github-flavored-markdown.rb b/dist/github-flavored-markdown.rb deleted file mode 100755 index 059b2605c..000000000 --- a/dist/github-flavored-markdown.rb +++ /dev/null @@ -1,153 +0,0 @@ -#!/usr/bin/env ruby -# -# JBoss, Home of Professional Open Source -# Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual -# contributors by the @authors tag. See the copyright.txt in the -# distribution for a full listing of individual contributors. -# -# 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. -# - - -require 'rubygems' -require 'redcarpet' -require 'nokogiri' -require 'fileutils' -require 'pygments.rb' -require 'rexml/document' - -# create a custom renderer that allows highlighting of code blocks -class HTMLWithPygmentsAndPants < Redcarpet::Render::HTML - include Redcarpet::Render::SmartyPants - def block_code(code, language) - Pygments.highlight(code, :lexer => language, :options => {:encoding => 'utf-8'}) - end - - #method copied from: https://gist.github.com/suan/5692767 - def header(title, level) - @headers ||= [] - - title_elements = REXML::Document.new(title) - flattened_title = title_elements.inject('') do |flattened, element| - flattened += if element.respond_to?(:text) - element.text - else - element.to_s - end - end - permalink = flattened_title.downcase.gsub(/[^a-z0-9\s]/, '').gsub(/\W+/, "-") - - # for extra credit: implement this as its own method - if @headers.include?(permalink) - permalink += "_1" - # my brain hurts - loop do - break if !@headers.include?(permalink) - # generate titles like foo-bar_1, foo-bar_2 - permalink.gsub!(/\_(\d+)$/, "_#{$1.to_i + 1}") - end - end - @headers << permalink - %(\n#{title}\n) - end -end - - -def find(p, tag) - if p.text - r = p.text[/^(#{tag}: )(.+)$/, 2] - if r - p['id'] = 'metadata' - return r - end - end -end - -def find_split(p, tag) - s = find(p, tag) - if s - return s.split(',').sort - end -end - -def metadata(source_path, html) - # TODO canonicalise path - toc_file='dist/target/toc.html' - # Markdown doesn't have an metadata syntax, so all we can do is pray ;-) - # Look for a paragraph that contains tags, which we define by convention - page_content = Nokogiri::HTML(html) - technologies = [] - level = "" - prerequisites = [] - summary = "" - page_content.css('p').each do |p| - t = find_split(p, 'Technologies') - if t - technologies = t - end - l = find(p, 'Level') - if l - level = l - end - pr = find_split(p, 'Prerequisites') - if pr - prerequisites = pr - end - s = find(p, 'Summary') - if s - summary = s - end - - end - dir = source_path[/([^\/]+)\/([^\/]+).md$/, 1] - filename = source_path[/([^\/]+)\/([^\/]+).md$/, 2] - if dir - output = "#{dir}#{' '.concat(technologies.map{|u| u} * ', ')}#{summary}#{level}#{' '.concat(prerequisites.map{|u| u} * ', ')}\n" - FileUtils.mkdir_p(File.dirname(toc_file)) - File.open(toc_file, 'a').write(output) - end -end - -def markdown(source_path) - renderer = HTMLWithPygmentsAndPants.new(optionize [ - :with_toc_data, - :xhtml - ]) - markdown = Redcarpet::Markdown.new(renderer, optionize([ - :fenced_code_blocks, - :no_intra_emphasis, - :tables, - :autolink, - :strikethrough, - :space_after_headers, - :with_toc_data - ])) - text = source_path.read - toc_file='dist/target/toc.html' - if File.exist?(toc_file) - qs_toc_content=File.open('dist/target/toc.html').read - qs_toc = "#{qs_toc_content}
Quickstart NameDemonstrated TechnologiesDescriptionExperience Level RequiredPrerequisites
" - text.gsub!("\[TOC-quickstart\]", qs_toc) - end - toc = Redcarpet::Markdown.new(Redcarpet::Render::HTML_TOC).render(text) - text.gsub!("\[TOC\]", toc) - rendered = markdown.render(text) - metadata(source_path.path, rendered) - rendered = rendered.gsub(/README.md/, "README.html").gsub(/CONTRIBUTING.md/, "CONTRIBUTING.html") - 'README' + rendered + '' - end - -def optionize(options) - options.each_with_object({}) { |option, memo| memo[option] = true } -end - -puts markdown(ARGF) - diff --git a/dist/headerdefinition.xml b/dist/headerdefinition.xml deleted file mode 100644 index a005641bc..000000000 --- a/dist/headerdefinition.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - /* - * - */ - (\\s|\\t)*/\\*.*$ - .*\\*/(\\s|\\t)*$ - false - true - - - - - ]]> - $]]> - - (\s|\t)*$]]> - false - true - - - - - ]]> - - (\s|\t)*$]]> - false - true - - - diff --git a/dist/license.txt b/dist/license.txt deleted file mode 100644 index 66acf5bb3..000000000 --- a/dist/license.txt +++ /dev/null @@ -1,14 +0,0 @@ -JBoss, Home of Professional Open Source -Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual -contributors by the @authors tag. See the copyright.txt in the -distribution for a full listing of individual contributors. - -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. diff --git a/dist/pom.xml b/dist/pom.xml deleted file mode 100644 index 117b076a6..000000000 --- a/dist/pom.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - 4.0.0 - - org.jboss - jboss-parent - 6-beta-2 - - - org.jboss.quickstarts.wfk - jboss-wfk-quickstarts-dist - 2.6.0-SNAPSHOT - pom - JBoss WFK Quickstarts Distribution - JBoss WFK Quickstarts Distribution - https://github.com/jboss-developer/jboss-wfk-quickstarts - - - - Apache License, Version 2.0 - repo - http://www.apache.org/licenses/LICENSE-2.0.html - - - - - - - maven-assembly-plugin - - - distribution - package - - single - - - - src/main/assembly/assembly.xml - - jboss-wfk-quickstarts-${project.version} - - - - - - - - diff --git a/dist/release-utils.sh b/dist/release-utils.sh deleted file mode 100755 index 3b1778000..000000000 --- a/dist/release-utils.sh +++ /dev/null @@ -1,198 +0,0 @@ -#!/bin/bash -# -# JBoss, Home of Professional Open Source -# Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual -# contributors by the @authors tag. See the copyright.txt in the -# distribution for a full listing of individual contributors. -# -# 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. -# - - -REQUIRED_BASH_VERSION=3.0.0 - -if [[ $BASH_VERSION < $REQUIRED_BASH_VERSION ]]; then - echo "You must use Bash version 3 or newer to run this script" - exit -fi - - -DIR=$(cd -P -- "$(dirname -- "$0")" && pwd -P) - -# DEFINE - -ARCHETYPES=("jboss-javaee6-webapp-archetype" "jboss-javaee6-webapp-ear-archetype") -QUICKSTARTS=("kitchensink" "kitchensink-ear") -VERSIONS_MAVEN_PLUGIN_VERSION=1.3.1 - -# SCRIPT - -HUMAN_READABLE_ARCHETYPES="" -i=0 -element_count=${#ARCHETYPES[@]} -index=0 -while [ "$index" -lt "$element_count" ] -do - if [ $index -ne 0 ] - then - HUMAN_READABLE_ARCHETYPES="${HUMAN_READABLE_ARCHETYPES}, " - fi - HUMAN_READABLE_ARCHETYPES="${HUMAN_READABLE_ARCHETYPES}${ARCHETYPES[index]}" - ((index++)) -done - - -usage() -{ -cat << EOF -usage: $0 options - -This script aids in releasing the quickstarts - -OPTIONS: - -u Updates version numbers in all POMs, used with -o and -n - -o Old version number to update from - -n New version number to update to - -r Regenerate the various quickstarts based on archetypes ${HUMAN_READABLE_ARCHETYPES} - -m Generate html versions of markdown readmes - -h Shows this message -EOF -} - -update() -{ - cd $DIR/../ - echo "Updating versions from $OLDVERSION TO $NEWVERSION for all Java files under $PWD" - perl -pi -e "s/${OLDVERSION}/${NEWVERSION}/g" `find . -name \*.java` - - echo "Performing updates to POMs" - poms=`find . -type f -iname "pom.xml" -maxdepth 3 | sort` - for pom in $poms - do - echo "Updating ${pom}" - mvn org.codehaus.mojo:versions-maven-plugin:${VERSIONS_MAVEN_PLUGIN_VERSION}:set -DnewVersion=${NEWVERSION} -f ${pom} -q -s contributor-settings.xml - mvn org.codehaus.mojo:versions-maven-plugin:${VERSIONS_MAVEN_PLUGIN_VERSION}:commit -f ${pom} -q -s contributor-settings.xml - done -} - -markdown_to_html() -{ - cd $DIR/../ - - # Clear the contents from toc.html file - rm dist/target/toc.html - touch dist/target/toc.html - - # Loop through the sorted quickstart directories and process them - # Exclude the template directory since it's not a quickstart - subdirs=`find . -maxdepth 1 -type d ! -iname ".*" ! -iname "template" | sort` - for subdir in $subdirs - do - readmes=`find $subdir -maxdepth 1 -iname readme.md` - for readme in $readmes - do - echo "Processing $readme" - output_filename=${readme//.md/.html} - output_filename=${output_filename//.MD/.html} - $DIR/github-flavored-markdown.rb $readme > $output_filename - done - done - # Now process the root readme - cd $DIR/../ - readme=README.md - echo "Processing $readme" - output_filename=${readme//.md/.html} - output_filename=${output_filename//.MD/.html} - $DIR/github-flavored-markdown.rb $readme > $output_filename - - # Now process the contributing markdown - cd $DIR/../ - markdown_filename=CONTRIBUTING.md - echo "Processing $markdown_filename" - output_filename=${markdown_filename//.md/.html} - output_filename=${output_filename//.MD/.html} - $DIR/github-flavored-markdown.rb $markdown_filename > $output_filename - - # Now process the release procedure markdown - cd $DIR/../ - markdown_filename=RELEASE_PROCEDURE.md - echo "Processing $markdown_filename" - output_filename=${markdown_filename//.md/.html} - output_filename=${output_filename//.MD/.html} - $DIR/github-flavored-markdown.rb $markdown_filename > $output_filename -} - -regenerate() -{ - TMPDIR="$DIR/target/regen" - ROOTDIR="$DIR/../" - - rm -rf $TMPDIR - - mkdir -p $TMPDIR - - cd $TMPDIR - - element_count=${#ARCHETYPES[@]} - index=0 - while [ "$index" -lt "$element_count" ] - do - archetype=${ARCHETYPES[index]} - quickstart=${QUICKSTARTS[index]} - package=${quickstart//-/_} - name="JBoss AS Quickstarts: $quickstart" - echo "**** Regenerating $quickstart from $archetype" - mvn archetype:generate -DarchetypeGroupId=org.jboss.spec.archetypes -DarchetypeArtifactId=$archetype -DarchetypeVersion=$VERSION -DartifactId=jboss-as-$quickstart -DgroupId=org.jboss.as.quickstarts -Dpackage=org.jboss.as.quickstarts.$package -Dversion=$VERSION -DinteractiveMode=false -Dname="${name}" - ((index++)) - rm -rf $ROOTDIR/$quickstart - mv $TMPDIR/jboss-as-$quickstart $ROOTDIR/$quickstart - done - -} - -OLDVERSION="1.0.0-SNAPSHOT" -NEWVERSION="1.0.0-SNAPSHOT" -VERSION="1.0.0-SNAPSHOT" -CMD="usage" - -while getopts “muo:n:r:” OPTION - -do - case $OPTION in - u) - CMD="update" - ;; - h) - usage - exit - ;; - o) - OLDVERSION=$OPTARG - ;; - n) - NEWVERSION=$OPTARG - ;; - r) - CMD="regenerate" - VERSION=$OPTARG - ;; - m) - CMD="markdown_to_html" - ;; - [?]) - usage - exit - ;; - esac -done - -$CMD - diff --git a/dist/release.sh b/dist/release.sh deleted file mode 100755 index 70090c147..000000000 --- a/dist/release.sh +++ /dev/null @@ -1,163 +0,0 @@ -#!/bin/bash -# -# JBoss, Home of Professional Open Source -# Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual -# contributors by the @authors tag. See the copyright.txt in the -# distribution for a full listing of individual contributors. -# -# 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. -# - - -REQUIRED_BASH_VERSION=3.0.0 - -if [[ $BASH_VERSION < $REQUIRED_BASH_VERSION ]]; then - echo "You must use Bash version 3 or newer to run this script" - exit -fi - -DIR=$(cd -P -- "$(dirname -- "$0")" && pwd -P) - -# DEFINE - -VERSION_REGEX='([0-9]*)\.([0-9]*)([a-zA-Z0-9\.]*)' - -# EAP team email subject -EMAIL_SUBJECT="\${RELEASEVERSION} of JBoss Quickstarts released, please merge with https://github.com/jboss-eap/quickstart, tag and add to EAP maven repo build" -# EAP team email To ? -EMAIL_TO="mnovotny@redhat.com maschmid@redhat.com benevides@redhat.com" -EMAIL_FROM="\"JDF Publish Script\" " - - -# SCRIPT - -usage() -{ -cat << EOF -usage: $0 options - -This script performs a release of the Quickstarts - -OPTIONS: - -s Snapshot version number to update from - -n New snapshot version number to update to, if undefined, defaults to the version number updated from - -r Release version number -EOF -} - -notify_email() -{ - echo "***** Performing JBoss Quickstarts release notifications" - echo "*** Notifying JBoss EAP team" - subject=`eval echo $EMAIL_SUBJECT` - echo "Email from: " $EMAIL_FROM - echo "Email to: " $EMAIL_TO - echo "Subject: " $subject - # send email using sendmail - printf "Subject: $subject\nSee \$subject :)\n" | /usr/bin/env sendmail -f "$EMAIL_FROM" "$EMAIL_TO" -} - -release() -{ - BRANCH=$(parse_git_branch) - git checkout -b $RELEASEVERSION - echo "Regenerating html from markdown" - $DIR/release-utils.sh -m - echo "Releasing JBoss AS Quickstarts version $RELEASEVERSION" - $DIR/release-utils.sh -u -o $SNAPSHOTVERSION -n $RELEASEVERSION - echo "Removing unnecessary files" - git rm --cached -r dist/ - git rm --cached -r template/ - git commit -a -m "Prepare for $RELEASEVERSION release" - echo "Creating tag for $RELEASEVERSION" - git tag $RELEASEVERSION - mvn clean install -f $DIR/pom.xml - echo "Your zip file was generated at $DIR/target/jboss-wfk-quickstarts-$RELEASEVERSION-dist.zip" - $DIR/release-utils.sh -u -o $RELEASEVERSION -n $NEWSNAPSHOTVERSION - echo "Adding unnecessary files again..." - git add dist/ - git add template/ - git commit -a -m "Prepare for development of $NEWSNAPSHOTVERSION" - git checkout $BRANCH - #echo "Building Distribution zip" - #git checkout $RELEASEVERSION - #echo "Uploading distribution to http://download.jboss.org/jbossas/$MAJOR_VERSION.$MINOR_VERSION/jboss-as-$RELEASEVERSION/jboss-wfk-quickstarts-$RELEASEVERSION-dist.zip" - #rsync -Pv --protocol=28 $DIR/target/jboss-wfk-quickstarts-$RELEASEVERSION-dist.zip jbossas@filemgmt.jboss.org:downloads_htdocs/jbossas/$MAJOR_VERSION.$MINOR_VERSION/jboss-wfk-$RELEASEVERSION/ - read -p "Do you want to send release notifcations to $EAP_EMAIL_TO[y/N]?" yn - case $yn in - [Yy]* ) notify_email;; - esac - echo "Don't forget to push the tag and the branch" -# echo " git push --tags upstream refs/heads/$RELEASEVERSION master" - echo " git push --tags upstream $BRANCH" -} - -parse_git_branch() { - git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/\1/' -} - - -SNAPSHOTVERSION="UNDEFINED" -RELEASEVERSION="UNDEFINED" -NEWSNAPSHOTVERSION="UNDEFINED" -MAJOR_VERSION="UNDEFINED" -MINOR_VERSION="UNDEFINED" - -while getopts “n:r:s:” OPTION - -do - case $OPTION in - h) - usage - exit - ;; - s) - SNAPSHOTVERSION=$OPTARG - ;; - r) - RELEASEVERSION=$OPTARG - ;; - n) - NEWSNAPSHOTVERSION=$OPTARG - ;; - [?]) - usage - exit - ;; - esac -done - -if [[ $RELEASEVERSION =~ $VERSION_REGEX ]]; then - MAJOR_VERSION=${BASH_REMATCH[1]} - MINOR_VERSION=${BASH_REMATCH[2]} -fi - -if [ "$NEWSNAPSHOTVERSION" == "UNDEFINED" ] -then - NEWSNAPSHOTVERSION=$SNAPSHOTVERSION -fi - -if [ "$MAJOR_VERSION" == "UNDEFINED" -o "$MINOR_VERSION" == "UNDEFINED" ] -then - echo "\nUnable to extract major and minor versions\n" - usage - exit -fi - -if [ "$SNAPSHOTVERSION" == "UNDEFINED" -o "$RELEASEVERSION" == "UNDEFINED" ] -then - echo "\nMust specify -r and -s\n" - usage - exit -fi - -release - diff --git a/dist/src/main/assembly/assembly.xml b/dist/src/main/assembly/assembly.xml deleted file mode 100644 index e59337389..000000000 --- a/dist/src/main/assembly/assembly.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - dist - jboss-as-quickstarts-${project.version} - - zip - - - - - ${project.basedir}/.. - / - - dist/** - template/** - **/target/** - **/.project - **/.settings/** - **/.classpath - **/.gitignore - - - - - diff --git a/helloworld-errai/functional-tests/pom.xml b/helloworld-errai/functional-tests/pom.xml index 952f29201..47099d7cf 100644 --- a/helloworld-errai/functional-tests/pom.xml +++ b/helloworld-errai/functional-tests/pom.xml @@ -21,7 +21,7 @@ org.jboss.as.quickstarts.wfk jboss-helloworld-errai-test-webdriver - 2.6.0-SNAPSHOT + 2.6.0.ER1 JBoss AS Quickstarts: Hello World test via WebDriver with Arquillian This project tests a starter Java EE 6 webapp project for use on JBoss AS 7 / EAP 6 by WebDriver diff --git a/helloworld-errai/pom.xml b/helloworld-errai/pom.xml index 5d5eea6aa..8f5734092 100644 --- a/helloworld-errai/pom.xml +++ b/helloworld-errai/pom.xml @@ -21,7 +21,7 @@ org.jboss.quickstarts.wfk jboss-helloworld-errai - 2.6.0-SNAPSHOT + 2.6.0.ER1 war JBoss WFK Quickstart: helloworld-errai diff --git a/helloworld-gwt/pom.xml b/helloworld-gwt/pom.xml index a714790b2..220b91096 100644 --- a/helloworld-gwt/pom.xml +++ b/helloworld-gwt/pom.xml @@ -21,7 +21,7 @@ org.jboss.quickstarts.wfk jboss-helloworld-gwt - 2.6.0-SNAPSHOT + 2.6.0.ER1 war JBoss WFK Quickstart: helloworld-gwt JBoss WFK Quickstart: Hello World with GWT front-end client diff --git a/template/README.md b/template/README.md deleted file mode 100644 index e9a85cc1b..000000000 --- a/template/README.md +++ /dev/null @@ -1,251 +0,0 @@ -QUICKSTART_NAME: Brief Description of the Quickstart -====================================================== -Author: YOUR_NAME and optional CONTACT_INFO -Level: [one of the following: Beginner, Intermediate, or Advanced] -Technologies: (list technologies used here) -Summary: (a brief description of the quickstart to appear in the table ) -Prerequisites: (list any quickstarts that must be deployed prior to running this one) -Target Product: (EAP, WFK, JDG, etc.) -Product Versions: (EAP 6.1, EAP 6.2, WFK 2.6, etc.) -Source: (The URL for the repository that is the source of record for this quickstart) - - -_This file is meant to serve as a template or guideline for your own quickstart README.md file. Be sure to replace QUICKSTART_NAME and YOUR_NAME, with the appropriate values._ - -Contributor instructions are prefixed with 'Contributor: ' - -What is it? ------------ - -Contributor: This is where you provide an overview of what the quickstart demonstrates. For example: - - * What are the technologies demonstrated by the quickstart? - * What does it do when you run it? - -You should include any information that would help the user understand the quickstart. - -If possible, give an overview, including any code they should look at to understand how it works.. - - -System requirements -------------------- - -Contributor: For example: - - -The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform (EAP) 6.1 or later with the Red Hat JBoss Web Framework Kit (WFK) 2.5. - -All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later. - - -Configure Maven ---------------- - -Contributor: You can copy or link to the Maven configuration information in the README file in the root folder of the quickstarts. For example: - -If you have not yet done so, you must [Configure Maven](../README.md#configure-maven) before testing the quickstarts. - - -Configure Optional Components -------------------------- - -Contributor: If your quickstart requires any additional components, decribe how to set them up here. If your quickstart requires a secured user, PostgreSQL, or Byteman, you can link to the instructions in the README file located in the root folder of the quickstart directory. Here are some examples: - - * This quickstart uses a secured management interface and requires that you create a management (or application) user to access the running application. Instructions to set up a Management (or Application) user can be found here: - - * [Add a Management User](../README.md#add-a-management-user) - - * [Add an Application User](../README.md#add-an-application-user) - - * This quickstart requires the PostgreSQL database. Instructions to install an configure PostgreSQL can be found here: [Install and Configure the PostgreSQL Database](../README.md#install-and-configure-the-postgresql-database) - - * This quickstart uses Byteman to help demonstrate crash recovery. Instructions to install and configure Byteman can be found here: [Install and Configure Byteman](../README.md#install-and-configure-byteman) - - -Start the JBoss EAP Server -------------------------- - -Contributor: Does this quickstart require one or more running servers? If so, you must show how to start the server. If you start the server in one of the following 3 ways, you can simply copy the instructions in the README file located in the root folder of the quickstart directory: - - * Start the Default JBoss EAP Server - - * Start the JBoss EAP Server with the Full Profile - - * Start the JBoss EAP Server with Custom Options. You will need to provide the argument string to pass on the command line, for example: - - `--server-config=../../docs/examples/configs/standalone-xts.xml` - -Contributor: If the server is started in a different manner than above, give the specific instructions. - - -Build and Deploy the Quickstart -------------------------- - -Contributor: If the quickstart is built and deployed using the standard Maven commands, "mvn clean package" and "mvn jboss-as:deploy", copy the following: - -_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.md#build-and-deploy-the-quickstarts) for complete instructions and additional options._ - -1. Make sure you have started the JBoss EAP server as described above. -2. Open a command line and navigate to the root directory of this quickstart. -3. Type this command to build and deploy the archive: - - mvn clean package jboss-as:deploy -4. This will deploy `target/jboss-QUICKSTART_NAME.war` (or `target/jboss-QUICKSTART_NAME.ear`) to the running instance of the server. - -Contributor: Be sure to replace the QUICKSTART_NAME. If this quickstart requires different or additional instructions, be sure to modify or add those instructions here. - - -Access the application (For quickstarts that have a UI component) ---------------------- - -Contributor: Provide the URL to access the running application. Be sure to make the URL a hyperlink as below, substituting the your quickstart name for the QUICKSTART_NAME. - - Access the running application in a browser at the following URL: - - -Contributor: Briefly describe what you will see when you access the application. For example: - - You will be presented with a simple form for adding key/value pairs and a checkbox to indicate whether the updates should be executed using an unmanaged component. - - If the box is checked, the updates will be executed within a session bean method. - If the box is not checked, the transactions and JPA updates will run in a servlet instead of session beans. - - To list all existing key/value pairs, leave the key input box empty. - - To add or update the value of a key, enter a key and value input boxe and click the submit button to see the results. - -Contributor: Add any information that will help them run and understand your quickstart. - - -Undeploy the Archive --------------------- - -Contributor: For example: - -1. Make sure you have started the JBoss EAP server as described above. -2. Open a command line and navigate to the root directory of this quickstart. -3. When you are finished testing, type this command to undeploy the archive: - - mvn jboss-as:undeploy - - -Run the Arquillian Tests (For quickstarts that contain Arquillian tests) -------------------------- - -Contributor: For example: - -This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container. - -_NOTE: The following commands assume you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Run the Arquillian Tests](../README.md#run-the-arquillian-tests) for complete instructions and additional options._ - -1. Make sure you have started the JBoss EAP server as described above. -2. Open a command line and navigate to the root directory of this quickstart. -3. Type the following command to run the test goal with the following profile activated: - - mvn clean test -Parq-jbossas-remote - -Contributor: The quickstart README should show what to expect from the the tests - -* Copy and paste output from the JUnit tests to show what to expect in the console from the tests. - -* Copy and paste log messages output by the application to show what to expect in the server log when running the tests. - - - -Run the Quickstart in JBoss Developer Studio or Eclipse -------------------------------------- -Contributor: For example: - -You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.md#use-jboss-developer-studio-or-eclipse-to-run-the-quickstarts) - -Debug the Application ------------------------------------- - -Contributor: For example: - -If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them. - - mvn dependency:sources - mvn dependency:resolve -Dclassifier=javadoc - - - -Build and Deploy the Quickstart - to OpenShift -------------------------- - -Contributor: If the quickstart deploys to OpenShift, you can use the following template a starting point to describe the process. Be sure to note: - -* APPLICATION_NAME should be replaced with a variation of the quickstart name, for example: myquickstart -* QUICKSTART_NAME should be replaced with your quickstart name, for example: my-quickstart - -### Create an OpenShift Account and Domain - -If you do not yet have an OpenShift account and domain, [Sign in to OpenShift](https://openshift.redhat.com/app/login) to create the account and domain. [Get Started with OpenShift](https://openshift.redhat.com/app/getting_started) will show you how to install the OpenShift Express command line interface. - -### Create the OpenShift Application - -Open a shell command prompt and change to a directory of your choice. Enter the following command, replacing APPLICATION_TYPE with `jbosseap-6` for quickstarts running on JBoss Enterprise Application Platform 6.1 or later: - - rhc app create -a APPLICATION_NAME -t APPLICATION_TYPE - -_NOTE_: The domain name for this application will be APPLICATION_NAME-YOUR_DOMAIN_NAME.rhcloud.com`. Here we use the _quickstart_ domain. You will need to replace it with your own OpenShift domain name. - -This command creates an OpenShift application named and will run the application inside the `jbosseap-6` container. You should see some output similar to the following: - - Creating application: APPLICATION_NAME - Now your new domain name is being propagated worldwide (this might take a minute)... - Warning: Permanently added 'APPLICATION_NAME-quickstart.rhcloud.com,107.22.36.32' (RSA) to the list of known hosts. - Confirming application 'APPLICATION_NAME' is available: Success! - - APPLICATION_NAME published: http://APPLICATION_NAME-quickstart.rhcloud.com/ - git url: ssh://b92047bdc05e46c980cc3501c3577c1e@APPLICATION_NAME-quickstart.rhcloud.com/~/git/APPLICATION_NAME.git/ - Successfully created application: APPLICATION_NAME - -The create command creates a git repository in the current directory with the same name as the application. Notice that the output also reports the URL at which the application can be accessed. Make sure it is available by typing the published url into a browser or use command line tools such as curl or wget. - -### Migrate the Quickstart Source - -Now that you have confirmed it is working you can migrate the quickstart source. You do not need the generated default application, so navigate to the new git repository directory and tell git to remove the source and pom files: - - cd APPLICATION_NAME - git rm -r src pom.xml - -Copy the source for the QUICKSTART_NAME quickstart into this new git repository: - - cp -r QUICKSTART_HOME/QUICKSTART_NAME/src . - cp QUICKSTART_HOME/QUICKSTART_NAME/pom.xml . - -### Configure the OpenShift Server - -Contributor: Here you describe any modifications needed for the `.openshift/config/standalone.xml` file. See other quickstart README.md files for examples. - -### Deploy the OpenShift Application - -You can now deploy the changes to your OpenShift application using git as follows: - - git add src pom.xml - git commit -m "QUICKSTART_NAME quickstart on OpenShift" - git push - -The final push command triggers the OpenShift infrastructure to build and deploy the changes. - -Note that the `openshift` profile in `pom.xml` is activated by OpenShift, and causes the war build by openshift to be copied to the `deployments` directory, and deployed without a context path. - -### Test the OpenShift Application - -When the push command returns you can test the application by getting the following URL either via a browser or using tools such as curl or wget: - -* - -You can use the OpenShift command line tools or the OpenShift web console to discover and control the application. - -### Destroy the OpenShift Application - -When you are finished with the application you can destroy it as follows: - - rhc app destroy -a APPLICATION_NAME - -_Note_: There is a limit to the number of applications you can deploy concurrently to OpenShift. If the `rhc app create` command returns an error indicating you have reached that limit, you must destroy an existing application before you continue. - -* To view the list of your OpenShift applications, type: `rhc domain show` -* To destroy an existing application, type the following, substituting the application name you want to destroy: `rhc app destroy -a APPLICATION_NAME_TO_DESTROY` diff --git a/template/pom.xml b/template/pom.xml deleted file mode 100644 index 2a373fa77..000000000 --- a/template/pom.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - 4.0.0 - - org.jboss.quickstarts.eap - jboss-QUICKSTART_NAME - 2.6.0-SNAPSHOT - war - JBoss PRODUCT_TYPE Quickstart: QUICKSTART_NAME-OPTIONAL_SUBFOLDER_NAME - QUICKSTART_NAME: A short description of this quickstart - - http://jboss.org/jbossas - - - Apache License, Version 2.0 - repo - http://www.apache.org/licenses/LICENSE-2.0.html - - - - - - - UTF-8 - - - - 7.4.Final - - 3.0.2.Final - - - - - 2.1.1 - - - 1.6 - 1.6 - - - - - - - - org.jboss.spec - jboss-javaee-6.0 - ${version.jboss.spec.javaee.6.0} - pom - import - - - - - - - - - javax.enterprise - cdi-api - provided - - - - - org.jboss.spec.javax.annotation - jboss-annotations-api_1.1_spec - provided - - - - - org.jboss.spec.javax.faces - jboss-jsf-api_2.1_spec - provided - - - - - org.hibernate.javax.persistence - hibernate-jpa-2.0-api - provided - - - - - org.jboss.spec.javax.transaction - jboss-transaction-api_1.1_spec - provided - - - - - org.jboss.spec.javax.ejb - jboss-ejb-api_3.1_spec - provided - - - - - - - ${project.artifactId} - - - maven-war-plugin - ${version.war.plugin} - - - false - - - - - org.jboss.as.plugins - jboss-as-maven-plugin - ${version.jboss.maven.plugin} - - - - - -