Doc updates and add release_process.md

This commit is contained in:
James Laska 2014-02-26 10:48:34 -05:00
parent d9d8fbd432
commit e8d6d69fff
3 changed files with 48 additions and 11 deletions

View File

@ -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.

View File

@ -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

34
docs/release_process.md Normal file
View File

@ -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 <X.Y.Z>
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