From 1ce78b637c945f07b864c193dc024b1b072af25b Mon Sep 17 00:00:00 2001 From: Rafael Benevides Date: Wed, 16 Jan 2013 10:17:10 -0200 Subject: [PATCH] Added Contributing Guide and Release Procedure --- CONTRIBUTING.md | 2 +- RELEASE_PROCEDURE.md | 86 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 RELEASE_PROCEDURE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f2558a231..3e1572352a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ Purpose of the quickstarts Basic Steps ----------- -To contribute with Quickstarts, clone your own fork instead of cloning the main Quickstarts repository, commit your work on topic branches and make pull requests. In detail: +To contribute to the quickstarts, fork the quickstart repository to your own Github, clone your fork, commit your work on topic branches and make pull requests. In detail: 1. [Fork](https://github.com/jboss-jdf/jboss-as-quickstart/fork_select) the project. diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md new file mode 100644 index 0000000000..754c0c753c --- /dev/null +++ b/RELEASE_PROCEDURE.md @@ -0,0 +1,86 @@ +Quickstarts Release Procedure +============================== + +Testing the quickstarts +----------------------- + + Most of the quickstarts require JBoss Enterprise Application Platform or JBoss AS only in standalone mode. Some require the "standalone-full" profile, some require XTS, some require Postgres and some require other quickstarts to be deployed. Profiles are used in the root POM to separate out these groups, allowing you to test the quickstarts easily. For example, to run those that require only standalone mode: + + mvn clean install jboss-as:deploy jboss-as:undeploy -Parq-jbossas-remote -P-requires-postgres,-requires-full,-complex-dependencies,-requires-xts + + Or, to run those only those quickstarts that require the full profile + + mvn clean install jboss-as:deploy jboss-as:undeploy -Parq-jbossas-remote -P-requires-postgres,-default,-complex-dependencies,-requires-xts + + And so on. + +Quickstarts in other repositories +--------------------------------- + + If the quickstarts are stored in another repository, you may wish to merge them in from there, do this: + + 1. Add the other repo as a remote + + git remote add -f + + 2. Merge from the tag in the other repo that you wish to use. It is important to use a tag, to make tracking of history easier. We use a recursive merge strategy, always preferring changes from the other repo, in effect overwriting what we have locally. + + git merge -s recursive -Xtheirs -m "Merge ''" + + 3. Review and push to upstream + + git push upstream HEAD:master + +Rendering Markdown +------------------ + + The quickstarts use Redcarpet to process the markdown, the same processor used by GitHub. This builds on the basic markdown syntax, adding support for tables, code highlighting, relaxed code blocks etc). We add a couple of custom piece of markup - \[TOC\] which allows a table of contents, based on headings, to be added to any file, and [Quickstart-TOC], which adds in a table listing the quickstarts. + + To render the quickstarts README's you will need, a working Ruby and Python install, with the various gems and eggs set up. + + Then just run + + ./dist/release-utils.sh -m + + To render all markdown files to HTML. + +Publishing builds to Maven +-------------------------- + + 1. You must have gpg set up and your key registered, as described at + 2. You must provide a property `gpg.passphrase` in your `settings.xml` in the `release` profile e.g. + + + release + + myPassPhrase + + + 3. You must have a JBoss Nexus account, configured with the server id in `settings.xml` with the id `jboss-releases-repository` e.g. + + + jboss-releases-repository + myUserName + myPassword + + + 4. Add `org.sonatype.plugins` plugin group to your `settings.xml` so nexus plugin can be available for publishing scripts. + + + org.sonatype.plugins + + +Release Procedure +----------------- + + 1. Make sure you have access to rsync files to `filemgmt.jboss.org/download_htdocs/jbossas` + 2. Release the archetypes + 3. Regenerate the quickstart based on archetypes + + dist/release-utils.sh -r + + 4. Release + + dist/release.sh -s -r + + This will update the version number, commit and tag, build the distro zip and upload it to . Then it will reset the version number back to the snapshot version number.