Packaging Modules

By Nathaniel Halbrooks
2 min

 

This Process prepares modules to be packaged for module deployment using FreePBX's Mirror Servers. It does NOT have to be used if the modules will be distributed locally or through a package distribution system not managed by http://FreePBX.org

  1. If you would like to see what has been committed since the last release, go to your devtools folders and run checklog.php

    cd /usr/src/devtools ./checklog.php -m announcement

  2. Navigate to your module's repo.

    cd /usr/src/freepbx/announcement/

  3. Make sure to git checkout a branch that is prefixed with the name "release/" (Of note, you DID make sure to MERGE your changes into this branch...didn't you?)

    git checkout release/2.11

  4. Check to make sure module.xml has the correct supported version tag for framework (base version) that you want the module to show up under as the minimum. 

    This is the MINIMUM supported base version of this module. You can NOT have two different supported version numbers in the same release/ track.

    <supported>     <version>2.11</version> </supported>

  5. Save the file and commit your changes (if you need to) and push them forward.

    git add module.xml git commit -m 'I updated module.xml and added supported tags for FreePBX'

  6. Navigate to the devtools repo (This repo should be outside the scope of your FreePBX repos folder)

    cd /usr/src/devtools

  7. Run package.php

    ./package.php -m announcement Using /usr/src/freepbx Processing announcement...     Checking GIT Status...         Attempting to open module...Done         Fetching remote changes (not applying)...Done     Checking Module XML...Done         Checking if on Release Branch...Yes (Working With release/2.11)         Fetching remote changes and applying to release/2.11...Done     Checking to make sure supported version isn't doubled...         Checking origin/release/0.2...module.xml is missing supported tag         Checking origin/release/0.8...module.xml is missing supported tag         Checking origin/release/2.4...module.xml is missing supported tag         Checking origin/release/2.5...module.xml is missing supported tag         Checking origin/release/2.6...module.xml is missing supported tag         Checking origin/release/2.7...module.xml is missing supported tag         Checking origin/release/2.8...module.xml is missing supported tag         Checking origin/release/2.9...module.xml is missing supported tag         Checking origin/release/2.10...module.xml is missing supported tag     Checking for PHP Syntax Errors...There are no errors     Checking Modified Module XML...Done     Running GIT...         Checking for Modified or New files...No Modified or New Files         Checking to see if local tag already exists...It doesn't         Checking to see if remote tag on origin already exists...It doesn't         Adding Tag at this state...Done         Pushing to origin...Done Module announcement version 2.11.0.0 has been successfully tagged! Package Script Report: ---------------------- Module announcement version 2.11.0.0 has been successfully tagged! ----------------------

  8. The new tag will be applied to the repo after checking has been completed. Sever Packaging can now be run by a FreePBX Developer

Return to Documentation Home I Return to Sangoma's Help Center