diff --git a/README.md b/README.md index 54d3111e80..5b87cb2471 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ -AWX -=== +Ansible Tower +============= -Formerly known as ansible-commander and AnsibleWorks, AWX provides a web-based -user interface, REST API and task engine built on top of Ansible. +Formerly known as awx, ansible-commander and AnsibleWorks, ansible-tower +provides a web-based user interface, REST API and task engine built on top of +Ansible. The current version under development is 1.4.8, and uses the master branch. @@ -22,8 +23,10 @@ master. Resources --------- -Refer to `CONTRIBUTING.md` to get started developing, testing and building AWX. +Refer to `CONTRIBUTING.md` to get started developing, testing and building Tower. -Refer to `setup/README.md` to get started deploying AWX. +Refer to `setup/README.md` to get started deploying Tower. -See `docs/build_system.md` for more about Jenkins and installing nightly builds (as opposed to running from source). +Refer to `docs/build_system.md` for more about Jenkins and installing nightly builds (as opposed to running from source). + +Refer to `docs/release_process.md` for information on the steps involved in creating a release. diff --git a/docs/build_system.md b/docs/build_system.md index d1a80d30f9..b42f2c3f73 100644 --- a/docs/build_system.md +++ b/docs/build_system.md @@ -1,5 +1,5 @@ -AWX Build and Release Process -============================= +Build and Release Process +========================= This document describes the AWX Software build and release process. This process includes the automation of the packaging for Debian/Ubuntu @@ -19,8 +19,8 @@ the `awx/__init__.py file.` This string should always be of the format: There should only be one "-" contained in the string. (Which can represent a build/rev type release number). Example: - - 1.2.2-0 + + 1.2.2-0 ### OFFICIAL vs. Non-OFFICIAL Builds ### diff --git a/docs/release_process.md b/docs/release_process.md new file mode 100644 index 0000000000..a24f83a8d3 --- /dev/null +++ b/docs/release_process.md @@ -0,0 +1,34 @@ +Release Process +=============== + +This document describes the process of created and publishing an Ansible Tower release. + +Time for a release +------------------ + +When the time comes for a release, the first step is to tag the release in git. + # git tag + +Monitor Jenkins +--------------- +Once tagged, [Jenkins](http://50.116.42.103/view/Tower/) will take care of the +following steps. The jenkins job +[Release_Tower](http://50.116.42.103/view/Tower/job/Release_Tower/) will detect +the recent tag, and initiate the `OFFICIAL=yes` build process. + +The following jobs will be triggered: +* [Build_Tower_TAR](http://50.116.42.103/view/Tower/) +* [Build_Tower_DEB](http://50.116.42.103/view/Tower/) + * [Build_Tower_AMI](http://50.116.42.103/view/Tower/) +* [Build_Tower_RPM](http://50.116.42.103/view/Tower/) +* [Build_Tower_Docs](http://50.116.42.103/view/Tower/) + +Should any build step fail, Jenkins will emit a message in IRC and set the build status to failed. + +Publishing Builds +----------------- +Upon successful completion, jenkins will publish build artifacts to the following locations: + +* http://releases.ansible.com/ansible-tower/rpm +* http://releases.ansible.com/ansible-tower/deb +* http://releases.ansible.com/ansible-tower/setup