THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Some notes on how Roller releases are orchestrated.
The Release Cycle
Roller releases are made on an as needed basis. Here's an overview of the release cycle.
When a Roller PMC member would like to make a release at some point in the future, he/she simply proposes that release to the Roller dev mailing list.
After some of the planned features are added, a committer may propose a milestone build. Milestone builds are not official releases, each is just a snapshot, so formal vote is not required, only lazy consensus. They may be tagged in Git and are made available via https://dist.apache.org/repos/dist/dev/roller. They are meant for testing only and not intended for production use, so there will be no migration scripts to help folks migrate data from milestone M1 to M2, etc.
Once a committer feels that the release is completely ready, he/she proposes to start making release candidates, also made available via https://dist.apache.org/repos/dist/dev/roller. A release candidate is a complete release, signed and ready to be shipped. Like milestone releases, release candidates are not official releases. They are meant for testing only and not intended for production use. After some feedback and testing has occurred and a release candidate appears to be good for final release, a vote is called. Once there are three +1 votes from PMC members the release can be made.
That's the overview, now let's talk detailsFollowing the philosophy of release early and release often, Roller aims for monthly releases. New releases will generally be scheduled for once per month around the beginning of the month. This is flexible and if the team feels a given month does not warrant a new release then we will wait until the following month.
Contributing to a release
If you want to add a feature to a release, you should create a JIRA issue describing the feature, assign it to yourself, and set the "fix-for" field for the release you want. (see the roadmap view in JIRA). For all but the smallest improvements and bug fixes, you should also write a proposal and get it reviewed by the community on the development mailing list (see the Ideas And Proposals page). If you are working on a feature marked as IN-PROGRESS in JIRA, then when you are done you should mark it as RESOLVED. Any work that is completed should be properly documented (user guide and/or install guide), change lists should be updated, and if needed database scripts are updated and tested.
Typical release schedule
Generally the team aims to provide the first release candidate (RC1) for a new release on the second to last Thursday of each month. Beginning at that point testing begins and focuses on those features marked RESOLVED for the given release. We iterate on RCs until the community is satisfied that all tests have passed and there are no more issues which should hold up the release. Then the release goes out, ideally around the beginning of each month. At that point all items which passed testing and are included in the release are marked as CLOSED.
Release Numbers and Versions
...
This section tells you where the right place is for your code and in general how the Roller repository is structured.
Roller
...
Master
The roller Roller trunk is the main development repository and will try to always represent the version of the code base currently being developed for the next release. Each new release will be made from the trunk and distributed as appropriate. It is expected that any code commited to the trunk will be in full working order _in time for the next scheduled release_
Roller
...
Release branch
At some point while we are making release candidates for a Roller release, we may decide to create a branch for the release. We do this in cases where it is very important that post-release development continue in the trunkThe roller dev branch will be a branch representing the next major version of roller. So if the roller trunk currently represents the 1.x code base, then the roller dev branch will be for the 2.x code. This branch is mainly created for cases where a certain feature requires enough effort that it is automatically going to be scheduled just for the next major release. This is also where all work that requires major schema changes should happen.
Custom branches
A custom branch can be created whenever a feature is in development that is not on a certain schedule. this allows the custom branch to worked at whatever pace is desired and when the code is ready it can be applied to whatever branch is most appropriate.
Tags
All tags in the subversion Git repository are meant to be read-only archives of versions of Roller that went final. If you are ever looking for the code to a specific version of Roller you should look here. In roller svn Git this is at tags/*.
Step-by-step How to Create a
...
Creating a new release from the trunk
coming soon.
Creating a patch release from an old version
coming soon.
An Example
Let's assume that Roller has just recently released version 2.0 and the code repository is as follows ...
| Code Block |
|---|
branches/roller_1.x (the old 1.x branch currently representing roller 1.3)
trunk (the current 2.x branch now representing roller 2.1 in progress)
branches/roller_3.x (the upcoming 3.x branch which doesn't have anything new yet)
|
Matt has some code he has done to implement Acegi security, but he isn't sure it's going to be ready for the 2.1 release so he gets a custom branch.
| Code Block |
|---|
branches/roller_acegi (acegi development work by Matt)
|
Dave and Allen finish up the 2.1 dev work and do a new release
| Code Block |
|---|
trunk (now represents 2.2 dev work)
|
Somebody finds a horrible bug in 1.2 (the last 1.x release) and decides it's worth taking the time to do a fix and release 1.3 from that branch.
| Code Block |
|---|
branches/roller_1.x (now represents potential 1.4 release)
|
Matt feels comfortable that the Acegi stuff is ready, so the acegi branch is put into the current trunk so it'll go into the 2.2 release.
| Code Block |
|---|
trunk (represents 2.2 dev work, with Matt's acegi code)
branches/roller_acegi (removed, no longer necessary)
|
Anil has some cool tag related feature to work on, but it requires a db change so he will work from the 3.x branch. Meanwhile, Dave, Allen, and Matt finish up the 2.2 code and do the release.
| Code Block |
|---|
branches/roller_3.x (anil doing tag work)
trunk (now represents 2.3 dev work)
|
Anil says his tag stuff will be ready within the month and the team agrees that now is a good time for a major release.
...
Release
1. Create a stable branch for the release
Name the branch with the format roller-{version}, e.g. roller-5.2.0
2. Update version numbers
You will need to change the version numbers in at least the files below:
pom.xml app/pom.xml assembly-release/pom.xml assembly-release/sign-release.sh it-selenium/pom.xml it-selenium/src/test/resources/roller-jettyrun.properties docs/roller-install-guide.odt docs/roller-user-guide.odt docs/roller-install-guide.odt3. Build Roller
Run a full build & test with "mvn install". If tests fail, you need to figure out why and rectify.
$ mvn install4. Build the release package
Change directory into the assembly-release directory and do a Maven build there: "mvn package"
$ cd assembly-release $ mvn package5. Sign the release
Before you can do this, you need to have GPG setup and a key in place for signing releases. To sign the release, you can use the sign-release.sh script in the assemly-release directory like so:
$ ./sign-release.sh6. Make the release available
You make the release available by committing it to a Subversion (SVN) repo at https://dist.apache.org/repos/dist/. Get that repo and take a look at the directory structure there. If you are creating a Release Candidate (RC) then it will go into a subdirectory of the "dev" directory and if you are making a final release, then it must go into the "release" directory.
For example a 5.2.0 RC1 release would go into
./dev/roller/roller-5.2/v5.2.0-rc-1Another example, a final 5.2.0 release would go into
./release/roller-5.2/v5.2.07. Update the website to point to the new files
Update the website's download links to point to the new release.
...