CAS/docs/Building

   1 ########################################
   2 ### Build process for phpCAS package ###
   3 ########################################
   4
   5 1. Prepare your own build config:
   6
   7 go to the utils/ dir and copy build-example.properties to a
   8 build.properties file and adjust the path for all needed binaries. You need
   9 at least php and doxygen for package creation. Git is needed as a developer with
  10 commit priviledges and upload right for the distribution package.
  11
  12 2. Install necessary php packages:
  13
  14 Install the pear package PEAR_PackageFileManager2 via the command
  15
  16 "pear install PEAR_PackageFileManager2"
  17
  18
  19 3. Run the "ant" tasks to build the phpCAS package and other developer tasks:
  20
  21 ant dist      # create a local package
  22 ant clean     # clear local packages and temporary files
  23 ant prepare   # The default action, tags, packages, and commits to the local git repository
  24 ant push      # Push the new commits and tags to the origin repository (github)
  25 ant upload    # Upload to jasig
  26 ant makeCurrentSymlink # Set the symbolic link on the jasig site for the most current packages
  27 ant revert    # To revert any "ant prepare" actions before they are pushed to the github repo
  28
  29 The ant prepare target is equivalent to ant tag && ant dist && ant markdev.
  30
  31 To revert the commits and tag additions added in the ant tag and ant markdev
  32 targets, use the new ant revert target. This should not be done after pushing.
  33 Running ant prepare is safe and can be followed by ant revert to get rid of the
  34 added commits and tag in your local repository.