Package: bda.recipe.deployment
============================================Buildout recipe managing project deployments============================================Overview========``bda.recipe.deployment`` offers a deployment cycle and helper scripts forbuildout based projects.Motivation==========While in small projects pinning checkout revisions or package versions in orderto deploy reconstructable setups works fine, the same strategy runs out ofit's possibilities as soon as it comes to deployment of projects wheresteps needed to publish a new feature not always follow a consistent andrepeating cycle.Consider following example. A customer comes up with two feature requests. Thecustomer always communicates with the project manager, from customer point ofview the cycle is clear. Each feature must be tested and after approving therollout could be made. Now the developer imlements feature one, and while thefirst feature waits for testing and approval, he wants to implement second onewithout influence to the approval cycle.The deployment cycle consists of three possible installations, further calledenvironments:DevelopmentThe development environment is used to develop features on developers localmaschine.Release CandidateThe environment on the testing maschine accessible for customers testing.LiveThe tested and stable live system.Process-------Overall process:1) Developer uses ``dev.cfg``. If changes were done``./bin/deploy candidate MODULENAME NEWVERSION`` is called. Modules RC-branch iscreated/synced and the sources section in file for rc environment is modifiedand committed.2) Release Manager uses ``rc.cfg`` on its testing checkout. After svn/git updateand buildout (re-)run the setup contains all release candidates branches.Software can be tested. In a second cycle Release Manager can merge changes fromdevelopment branch into rc branch.3) Release Manager decides to release a package after testing for live-usage.In rc-environment ``./bin/deploy release MODULENAME `` is called and the egg isuploaded to the configured eggserver or saved local. The live-versions sectionin file for live-environment is modifed and committed.4) Live-System-Administrator uses ``live.cfg`` on the live-deployment maschine.After git/svn up and buildout (re-)run the most recent releases are available.Optional (if configured) the RC steps 2 and 3  can be omitted and a release mayhappen from dev direct to live.While Developer and Release Candidate needs the add-on ``mr.developer``, Livedoes not it.Buildout Structure------------------Proposed buildout structure::dev.cfg (manual)rc.cfg (manual)live.cfg (manual)etc/base.cfg (manual)etc/deployment.cfg (manual)etc/sources-dev.cfg (manual)etc/sources-rc.cfg (generated)etc/versions-rc.cfg (generated)etc/versions-live.cfg (generated)cfg/versions-global.cfg (manual, optional)dev.cfgContains parts for local development, includes developer tools ifnecessary. Included parts:-``base.cfg``-``versions-global.cfg``-``sources-dev.cfg``,-``deployment.cfg``.rc.cfgContains parts for local on a test-server. Included parts:-``base.cfg``-``versions-global.cfg``-``versions-rc.cfg``-``sources-rc.cfg``,-``deployment.cfg``.live.cfgContains parts for deployment on a live-server. Included parts:-``base.cfg``-``versions-global.cfg``-``versions-live.cfg``base.cfgcontains all common sections and settingsof the buildout needed by allthree types of environment.deployment.cfgContains deployment specific sections and settings, such as parameters fordeployment and list of managed packages and which dist-server to use.global-versions.cfgContains the common version section. In smaller projects this can be put inbase.cfgsources-dev.cfgContains the sources-section for all developer controlled sources.sources-rc.cfgContains the sources for Release-Candidate setup. This file is generated byscripts. It points to the automatically created branches.versions-rc.cfgContains the versions of developer controlled sources used inrc-deployment. This are the packages which do not need a RC step.This file is generated by scripts.versions-live.cfgContains the versions of developer controlled sources used inlive-deployment. This file is generated by scripts.Commands--------In buildouts bin directory there are two main commands which itself have abunch of sub commands, the ``deploy`` and the ``bda_deployment_helper``. Latteris rarely used, i.e. you may need it to fix things. So the main tool for thedaily usage is ``deploy``:``deploy``main command for all daily taskssubcommands are context sensitive. In Dev environment there are othercommands available than in RC enviroment. So in Dev this are:``repopasswd``sets the username/ password for the pypi server``info``prints info about managed packages.``version``prints version of a package``candidate``prepare a release candidate for a package, this includes creation of abranch``release``make a release of a package, this includes tagging and upload to theindex (or local file release) and setting the version in``versions-rc.cfg`` and ``versions-live.cfg``.In RC the commands are:``repopasswd``see above``info``see above``version``see above``release``make a release of a package, this includes tagging and upload to theindex (or local file release) and setting the version in``versions-live.cfg``.``merge``merge current trunk/master branch of a package into the rc branchAll commands and subcommands have a help to find their paramaters.Source Code===========The sources are in a GIT DVCS with its main branches at`github <http://github.com/bluedynamics/bda.recipe.deployment>`_.We'd be happy to see many forks and pull-requests to make it even better.Contributors============- Jens W. Klein <jk [at] kleinundpartner [dot] at>- Robert Niederrreiter <rnix [at] squarewavea [dot] t>License=======Copyright (c) 2012, BlueDynamics Alliance, Austria, Switzerland, GermanyGNU GENERAL PUBLIC LICENSETERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION0. This License applies to any program or other work which containsa notice placed by the copyright holder saying it may be distributedunder the terms of this General Public License.  The "Program", below,refers to any such program or work, and a "work based on the Program"means either the Program or any derivative work under copyright law:that is to say, a work containing the Program or a portion of it,either verbatim or with modifications and/or translated into anotherlanguage.  (Hereinafter, translation is included without limitation inthe term "modification".)  Each licensee is addressed as "you".Activities other than copying, distribution and modification are notcovered by this License; they are outside its scope.  The act ofrunning the Program is not restricted, and the output from the Programis covered only if its contents constitute a work based on theProgram (independent of having been made by running the Program).Whether that is true depends on what the Program does.1. You may copy and distribute verbatim copies of the Program'ssource code as you receive it, in any medium, provided that youconspicuously and appropriately publish on each copy an appropriatecopyright notice and disclaimer of warranty; keep intact all thenotices that refer to this License and to the absence of any warranty;and give any other recipients of the Program a copy of this Licensealong with the Program.You may charge a fee for the physical act of transferring a copy, andyou may at your option offer warranty protection in exchange for a fee.2  You may modify your copy or copies of the Program or any portionof it, thus forming a work based on the Program, and copy anddistribute such modifications or work under the terms of Section 1above, provided that you also meet all of these conditions:a) You must cause the modified files to carry prominent noticesstating that you changed the files and the date of any change.b) You must cause any work that you distribute or publish, that inwhole or in part contains or is derived from the Program or anypart thereof, to be licensed as a whole at no charge to all thirdparties under the terms of this License.c) If the modified program normally reads commands interactivelywhen run, you must cause it, when started running for suchinteractive use in the most ordinary way, to print or display anannouncement including an appropriate copyright notice and anotice that there is no warranty (or else, saying that you providea warranty) and that users may redistribute the program underthese conditions, and telling the user how to view a copy of thisLicense.  (Exception: if the Program itself is interactive butdoes not normally print such an announcement, your work based onthe Program is not required to print an announcement.)These requirements apply to the modified work as a whole.  Ifidentifiable sections of that work are not derived from the Program,and can be reasonably considered independent and separate works inthemselves, then this License, and its terms, do not apply to thosesections when you distribute them as separate works.  But when youdistribute the same sections as part of a whole which is a work basedon the Program, the distribution of the whole must be on the terms ofthis License, whose permissions for other licensees extend to theentire whole, and thus to each and every part regardless of who wrote it.Thus, it is not the intent of this section to claim rights or contestyour rights to work written entirely by you; rather, the intent is toexercise the right to control the distribution of derivative orcollective works based on the Program.In addition, mere aggregation of another work not based on the Programwith the Program (or with a work based on the Program) on a volume ofa storage or distribution medium does not bring the other work underthe scope of this License.3. You may copy and distribute the Program (or a work based on it,under Section 2) in object code or executable form under the terms ofSections 1 and 2 above provided that you also do one of the following:a) Accompany it with the complete corresponding machine-readablesource code, which must be distributed under the terms of Sections1 and 2 above on a medium customarily used for software interchange; or,b) Accompany it with a written offer, valid for at least threeyears, to give any third party, for a charge no more than yourcost of physically performing source distribution, a completemachine-readable copy of the corresponding source code, to bedistributed under the terms of Sections 1 and 2 above on a mediumcustomarily used for software interchange; or,c) Accompany it with the information you received as to the offerto distribute corresponding source code.  (This alternative isallowed only for noncommercial distribution and only if youreceived the program in object code or executable form with suchan offer, in accord with Subsection b above.)The source code for a work means the preferred form of the work formaking modifications to it.  For an executable work, complete sourcecode means all the source code for all modules it contains, plus anyassociated interface definition files, plus the scripts used tocontrol compilation and installation of the executable.  However, as aspecial exception, the source code distributed need not includeanything that is normally distributed (in either source or binaryform) with the major components (compiler, kernel, and so on) of theoperating system on which the executable runs, unless that componentitself accompanies the executable.If distribution of executable or object code is made by offeringaccess to copy from a designated place, then offering equivalentaccess to copy the source code from the same place counts asdistribution of the source code, even though third parties are notcompelled to copy the source along with the object code.4. You may not copy, modify, sublicense, or distribute the Programexcept as expressly provided under this License.  Any attemptotherwise to copy, modify, sublicense or distribute the Program isvoid, and will automatically terminate your rights under this License.However, parties who have received copies, or rights, from you underthis License will not have their licenses terminated so long as suchparties remain in full compliance.5. You are not required to accept this License, since you have notsigned it.  However, nothing else grants you permission to modify ordistribute the Program or its derivative works.  These actions areprohibited by law if you do not accept this License.  Therefore, bymodifying or distributing the Program (or any work based on theProgram), you indicate your acceptance of this License to do so, andall its terms and conditions for copying, distributing or modifyingthe Program or works based on it.6. Each time you redistribute the Program (or any work based on theProgram), the recipient automatically receives a license from theoriginal licensor to copy, distribute or modify the Program subject tothese terms and conditions.  You may not impose any furtherrestrictions on the recipients' exercise of the rights granted herein.You are not responsible for enforcing compliance by third parties tothis License.7. If, as a consequence of a court judgment or allegation of patentinfringement or for any other reason (not limited to patent issues),conditions are imposed on you (whether by court order, agreement orotherwise) that contradict the conditions of this License, they do notexcuse you from the conditions of this License.  If you cannotdistribute so as to satisfy simultaneously your obligations under thisLicense and any other pertinent obligations, then as a consequence youmay not distribute the Program at all.  For example, if a patentlicense would not permit royalty-free redistribution of the Program byall those who receive copies directly or indirectly through you, thenthe only way you could satisfy both it and this License would be torefrain entirely from distribution of the Program.If any portion of this section is held invalid or unenforceable underany particular circumstance, the balance of the section is intended toapply and the section as a whole is intended to apply in othercircumstances.It is not the purpose of this section to induce you to infringe anypatents or other property right claims or to contest validity of anysuch claims; this section has the sole purpose of protecting theintegrity of the free software distribution system, which isimplemented by public license practices.  Many people have madegenerous contributions to the wide range of software distributedthrough that system in reliance on consistent application of thatsystem; it is up to the author/donor to decide if he or she is willingto distribute software through any other system and a licensee cannotimpose that choice.This section is intended to make thoroughly clear what is believed tobe a consequence of the rest of this License.8. If the distribution and/or use of the Program is restricted incertain countries either by patents or by copyrighted interfaces, theoriginal copyright holder who places the Program under this Licensemay add an explicit geographical distribution limitation excludingthose countries, so that distribution is permitted only in or amongcountries not thus excluded.  In such case, this License incorporatesthe limitation as if written in the body of this License.9. The Free Software Foundation may publish revised and/or new versionsof the General Public License from time to time.  Such new versions willbe similar in spirit to the present version, but may differ in detail toaddress new problems or concerns.Each version is given a distinguishing version number.  If the Programspecifies a version number of this License which applies to it and "anylater version", you have the option of following the terms and conditionseither of that version or of any later version published by the FreeSoftware Foundation.  If the Program does not specify a version number ofthis License, you may choose any version ever published by the Free SoftwareFoundation.10. If you wish to incorporate parts of the Program into other freeprograms whose distribution conditions are different, write to the authorto ask for permission.  For software which is copyrighted by the FreeSoftware Foundation, write to the Free Software Foundation; we sometimesmake exceptions for this.  Our decision will be guided by the two goalsof preserving the free status of all derivatives of our free software andof promoting the sharing and reuse of software generally.NO WARRANTY11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTYFOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHENOTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIESPROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSEDOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK ASTO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THEPROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,REPAIR OR CORRECTION.12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITINGWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/ORREDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISINGOUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITEDTO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BYYOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHERPROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES.END OF TERMS AND CONDITIONS