Skip to content
Browse files

#30 Update the Building document to properly explain the packaging

procedure and update the build-example.properties file.
  • Loading branch information...
1 parent 0d9b1a4 commit fc74e972a0bed94b64110a518f3673dca04e76da @jfritschi jfritschi committed
Showing with 55 additions and 28 deletions.
  1. +25 −4 docs/Building
  2. +30 −24 utils/build-example.properties
View
29 docs/Building
@@ -1,13 +1,34 @@
-Extract of: https://github.com/Jasig/phpCAS/pull/12
+########################################
+### Build process for phpCAS package ###
+########################################
-ant prepare # The default action, tags, packages, and commits to the local repository
+1. Prepare your own build config:
+
+go to the utils/ dir and copy build-example.properties to a
+build.properties file and adjust the path for all needed binaries. You need
+at least php and doxygen for package creation. Git is needed as a developer with
+commit priviledges and upload right for the distribution package.
+
+2. Install necessary php packages:
+
+Install the pear package PEAR_PackageFileManager2 via the command
+
+"pear install PEAR_PackageFileManager2"
+
+
+3. Run the "ant" tasks to build the phpCAS package and other developer tasks:
+
+ant dist # create a local package
+ant clean # clear local packages and temporary files
+ant prepare # The default action, tags, packages, and commits to the local git repository
ant push # Push the new commits and tags to the origin repository (github)
ant upload # Upload to jasig
-ant makeCurrentSymlink # Set the symbolic link on the jasig site.
+ant makeCurrentSymlink # Set the symbolic link on the jasig site for the most current packages
+ant revert # To revert any "ant prepare" actions before they are pushed to the github repo
+
The ant prepare target is equivalent to ant tag && ant dist && ant markdev.
To revert the commits and tag additions added in the ant tag and ant markdev
targets, use the new ant revert target. This should not be done after pushing.
-
Running ant prepare is safe and can be followed by ant revert to get rid of the
added commits and tag in your local repository.
View
54 utils/build-example.properties
@@ -1,24 +1,30 @@
-#
-# build-example.properties
-# This file is used by developers to generate distributions,
-# copy to build.properties before running ant tasks.
-#
-
-#
-# path to the doxygen executable
-#
-
-doxygen.path=C:/Program Files/doxygen/bin/doxygen.exe
-
-#
-# path to the git executable
-#
-
-git.path=/opt/local/bin/git
-
-#
-# information used to connect to the jasig website and upload/manage releases
-#
-
-upload.username=anonymous
-upload.password=yourpassword
+#
+# build-example.properties
+# This file is used by developers to generate distributions,
+# copy to build.properties before running ant tasks.
+#
+
+#
+# path to the doxygen executable
+#
+
+doxygen.path=C:/Program Files/doxygen/bin/doxygen.exe
+
+#
+# path to the git executable
+#
+
+git.path=/opt/local/bin/git
+
+#
+# path to the php executable
+#
+
+php.path=/usr/bin/php
+
+#
+# information used to connect to the jasig website and upload/manage releases
+#
+
+upload.username=anonymous
+upload.password=yourpassword

0 comments on commit fc74e97

Please sign in to comment.
Something went wrong with that request. Please try again.