Skip to content

Commit

Permalink
(fixes issue 85) Clarify developer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rburgst committed Nov 12, 2010
1 parent 4b2e3c7 commit 3480a3d
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions HACKING.txt
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
This file contains information for developing and testing Time Tracker.
This file contains information for building and packaging TimeTracker.

== If you only want to develop ==

Then all you need to do is open the Time Tracker.xcodeproj in XCode 3. Build
and run as you please.

== Prerequisites ==
* Rubygems
* gem install text-format
* gem install cucumber
* gem install rspec
* PowerPC XCode build symbols (you should have this if you have a default XCode install)

== Release Packaging ==

1. Make sure the version number is updated:
1a. Update CURRENT_PROJECT_VERSION for "All Configurations" in the Project Info.
1a. Update CURRENT_PROJECT_VERSION for "All Configurations" in the Project Info within XCode.

2. Update the ChangeLog.yml.


4. Build the Time Tracker.zip release file:
3. Build the Time Tracker.zip release file:
4a. Run `rake build_release`. This will create "build/Release/Time Tracker-$(CURRENT_PROJECT_VERSION).zip".

5. If Sparkle or the release file configuration has been changed, test the auto-update system:
4. If Sparkle or the release file configuration has been changed, test the auto-update system:
5a. Install the previous version of Time Tracker.
5b. Update and post appcast/timetracker-test.xml
5c. Open ~/Library/Preferences/com.slooz.timetracker.plist and change
Expand All @@ -26,24 +29,26 @@ This file contains information for developing and testing Time Tracker.
5d. Ensure that the old version of Time Tracker can update to the new version.
5e. Ensure that the new version of Time Tracker can update to itself.

6. Run `rake appcast` to generate appcast/timetracker-$(CURRENT_PROJECT_VERSION).html
and update appcast/timetracker-stable.xml
5. Run `rake appcast` to generate appcast/timetracker-$(CURRENT_PROJECT_VERSION).html

7. Publish the release:
7a. Run `rake upload`. You will need to enter your google code username and your googlecode
6. Publish the release:
6a. Run `rake upload`. You will need to enter your google code username and your googlecode
password which is found at http://code.google.com/hosting/settings
This will upload Time Tracker-$(CURRENT_PROJECT_VERSION).zip and
timetracker-$(CURRENT_PROJECT_VERSION).html to
http://time-tracker-mac.googlecode.com
7b. Upload timetracker-stable.xml to http://www.avh4.net/appcast/

8. Update the website:
8a. Update the homepage http://time-tracker-mac.googlecode.com
8b. Make the new release the featured download http://time-tracker-mac.googlecode.com
8c. Update iusethis.com
8d. Update versiontracker.com

9. Tag the release with "v$(CURRENT_PROJECT_VERSION)" and push the commit.
6b. Check in appcast/timetracker-stable.xml or copy the latest release to the
appcast/timetracker-beta.xml (if you want to release it as beta).
Once you push the commit to google, the new release is visible to all users.


7. Update the website:
7a. Update the homepage http://time-tracker-mac.googlecode.com
7b. Make the new release the featured download http://time-tracker-mac.googlecode.com
7c. (Update iusethis.com)
7d. (Update versiontracker.com)

8. Tag the release with "v$(CURRENT_PROJECT_VERSION)" and push the commit.

== Appcast updates with Sparkle ==

Expand Down

0 comments on commit 3480a3d

Please sign in to comment.