Document Actions
Vasudeva Server Repository Workflow
Version 1.2 - Maintainers of this document: Atmasamarpan, Priyadarshan
DEVELOPMENT
0. HAVE A TICKET
Do not work unless and until you have a JIRA ticket open.
No JIRA ticket, no development, please!. You can open a ticket to yourself if necessary.
1. VERSION NUMBERING
Each script or product should have a VERSION.txt file which contains the version of the product. Do not not just make up your own version, but use the version listed in the respective ticket in JIRA (under the label "Affects Version/s".)
An example for vsCore would be (excluding the quote signs): "1.0-alpha-".
2. COMMENTING YOUR CHANGES
Every time you commit to the repository, add at least 2 lines at the top of the HISTORY.txt file, using this format:
- [added:, if new feature] or [fixed:, if bug fix] + URL to JIRA ticket + " - " +title of JIRA ticket
[name of developer that is committing]
HISTORY.txt Comment - Example 1
- added: http://jira.vasudevaserver.org/browse/COR-13 - Better place for site-wide properties
[dhyani]
HISTORY.txt Comment - Example 2
- fixed: http://jira.vasudevaserver.org/browse/COR-20 - CSS does not show correctly in skin
[tejaswi]
Please preserve the dash on the first line.
The name of developer in brackets on the second line has to be left aligned with "fixed" or "added".
3. COMMENTING YOUR REPOSITORY COMMITS
When you commit to the repository you have the option to add a comment.
Please, never commit without commenting!
It is very easy: just use the first line of the HISTORY.txt addition (as seen above).
4. COMMENTING YOUR TICKET IN JIRA
After committing to the repository, add the Revision Number returned by your svn client as a comment to the proper JIRA ticket.
This Revision Number is essential. It pinpoints and guarantees the state of your code at any given moment.
STAGING
5. DEPLOYMENT FOOR TESTING
When you need to test a product on Stage or Sandbox, you need to install it first.
For example, if you want to install “vsProduct“, revision number 755, use the following URLs.
Install on STAGE
http://stage.vasudevaserver.net/produpdate?repo=pub&product=vsProduct&tag=r755
Install on SANDBOX
http://sandbox.vasudevaserver.net:7077/produpdate?repo=pub&product=vsProduct&tag=r755
Note that the URL requires two parameters:
a) Product to install (example: vsCore)
b) Revision Number under which you committed the product (example: 755)
6. REQUEST FOR TESTING
After step 5, request somebody to test your product, specifying the Revision Number of the product you want to be tested on the proper JIRA ticket.
Please, DO NOT REQUEST TESTING without testing your code yourself thoroughly first!
GOING LIVE
7. GO AHEAD
Once your product has been tested and it is ready to go live, the tester will give the go ahead using the same JIRA ticket as above (and specifying the Revision Number.)
8. TAGGING (for Release manager)
A release manager (at this time, only Atmasamarpan) will specify which version number a given product will be assigned, writing it on the same ticket as above. The release manager will create a tag with any subversion client. A script will assign to VERSION.txt a string like this (excluding the quote signs): "1.0-alpha-r980"
9. DEPLOYMENT TO PRODUCTION SERVER
A system administrator will deploy the product on Production with the tag and refresh the product or restart teh zope instance.
10. SERVERS ACCESS SUMMARY
PRODUCTION is on port 80 (live sites)
Anon view: http://www.domain.tld
Editor view: https://my.domain.tld
STAGE is on port 8081 (Plone testing - current version)
Anon view: http://www.domain.tld:8081
Editor view: https://my.domain.tld:8081
SANDBOX port 8082 (Plone testing - latest version)
Anon view: http://www.domain.tld:8082
Editor view: https://my.domain.tld:8082
To be in the ZMI, just add /aq_parent/manage to the "my.domain" URL