Magento Expert Forum - Improve your Magento experience

Results 1 to 8 of 8

How to pack a Magento extension

  1. #1
    Junior Member ccvv's Avatar
    Join Date
    Mar 2013
    Posts
    66
    Thanks
    6
    Thanked 17 Times in 13 Posts

    Thumbs up How to pack a Magento extension

    This admin page will help to pack your extensions, such as modules, add-ons, language packs, interfaces and themes, into PEAR packages which you could upload to MagentoConnect and share with other community members.
    To start packing extensions, log in to Magento Admin panel and go to: Admin Panel: » System » Magento Connect » Package Extenssions.
    You can easily follow the 5 step process to generate the extension that are described in the remaining article.
    The extension packaging process includes generation of package.xml file with information about the package collected by the 5 steps below, and archiving content files and folders specified by the Contents step.
    After package is uploaded to Magento Connect, it will be available for downloading and installation for other members, by pasting extension key into Magento Connect downloader.
    Extension key is constructed from:

    • PEAR channel nickname (magento-coreormagento-community)
    • Short package name (Mage_Core_Modules)
    • Numeric release version (1.2.3) or release stability (beta) – optional>

    So the extension key could look like this:

    • magento-core/Mage_Core_Modules-1.2.3– specific release version will be installed
    • magento-core/Mage_Core_Modules-beta– latest beta release will be installed
    • magento-core/Mage_Core_Modules– latest release for local stability settings will be installed

    NOTES

    Make sure that downloader/pearlib/php and var/pear folders exist and have writable permissions for the web service.
    In version 1.0 you should run these commands before packaging extensions, to initialize PEAR packager:

    cd downloader ./pear mage-setup Channel fields can be:

    • CORE packages:connect.magentocommerce.com/core(nicknamemagento-core)
    • COMMUNITY packages:connect.magentocommerce.com/community(nicknamemagento-community)

    Any Suggestions on what to do in version 1.2?
    Packaging an extension

    This process is divided into 5 steps, detailed below.
    After all steps have been completed, you can click “Save” button to save package information info into var/pear/<package_name>.ser file for future retrieval by clicking “Load” button.
    Also you can generate the release package by clicking on “Save data and Create Package” button, which will validate information and create .tar.gz file in var/pear that you can upload to Magento Connect.
    Package Info

    Here is general information about package without regards to releases or versions

    • Name: PEAR short package name, ( Mage_Oscommerce )
    • Channel: For community packages use (connect.magentocommerce.com/community)
    • Summary: Short package definition
    • Description: Extended package definition
    • License: Extension license name (OSL v3.0)
    • License URI: Web URL for license text (http://www.opensource.org/licenses/osl-3.0.php)

    Release Info

    In this tab provide release/version specific information

    • Release Version: Major, minor, revision and stability for the release (1.1.20123)
    • API Version: Major and minor version for API used in this release (1.0)
    • Release Stability: Stability of this release (alpha)
    • API Stability: Stability of the API used in this release (stable)
    • Notes: Release notes for users and developers

    Maintainers (required)

    Maintainers of the package, user names the same as in MagentoConnect Only LEAD maintainers can upload releases The User field is your magentocommerce.com user name (found under My Account, User Name and Password). Don’t use your screen name here.
    Dependencies

    • PHP Version: this setup will work only with PHP5 >= 5.2.0
      • Minimum: 5.2.0
      • Maximum: 6.0.0
      • Exclude: 6.0.0

    Packages

    Dependencies for current package

    • Package: short package name (Mage_Core_Modules)
    • Channel:
    • Min: minimum supported version of dependent package
    • Max: maximum supported version of dependent package
    • Recommended: downloader will try to use this version even if newer available
    • Exclude: comma separated list of versions that are not supported
    • Type:
      • Required: this dependency required for successful installation
      • Optional: this package will be shown during installation as available option
      • Conflicts: this package versions conflict with current package

    Subpackages

    Used when new release of current package was split into 2 or more packages.
    In general, no packages can share same files, but subpackages can contain files that were used in previous version of current package.
    Fields: the same as in packages
    Extensions

    PHP /PECL extensions dependencies

    • Extension: dropdown with currently installed PHP extensions
    • Min, Max, Recommended, Exclude, Type: the same as in packages

    Contents (required)

    • Role: Location of the files to include
    • Path: Path within the role (location)
    • Type: File or Recursive Directory
    • Include: Regular expression for file pattern to include (requires pattern delimiter, like ‘#’) – ex. #^Mage#
    • Ignore: Regular expression for file pattern to ignore (requires pattern delimiter, like ‘#’)

    Source: Magentocommerce.com

    View more threads in the same category:


  2. #2
    Junior Member rocker's Avatar
    Join Date
    Mar 2013
    Posts
    106
    Thanks
    3
    Thanked 11 Times in 9 Posts

    Default

    It 's seem this is old instructions?

  3. #3
    Administrator david's Avatar
    Join Date
    Nov 2012
    Posts
    260
    Thanks
    23
    Thanked 40 Times in 33 Posts

    Default

    Quote Originally Posted by rocker View Post
    It 's seem this is old instructions?
    But it still work well

  4. #4
    Junior Member
    Join Date
    Jun 2013
    Posts
    31
    Thanks
    0
    Thanked 1 Time in 1 Post

    Default

    Good one!!! It works for me too.

  5. #5
    New member mavencrux's Avatar
    Join Date
    May 2013
    Posts
    6
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Default How to pack a Magento extension

    MagentoCRUX.com provides next-gen ecommerce solutions for Magento-based websites with themes, templates, extensions, plug-ins, support, bug-fixing, requirement based development, store optimization, SEO and store branding.

  6. #6
    Junior Member
    Join Date
    Aug 2013
    Location
    USA
    Posts
    355
    Thanks
    0
    Thanked 4 Times in 4 Posts

    Default

    magentoextensionstore.com is best E commerce Websites like this Themes, Templates, Extension, Plug-ins, Modules, Store Optimization and Many more services providing.

  7. #7
    New member
    Join Date
    Dec 2013
    Posts
    1
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Default

    Hello. Would instructions for adding versions for an extension be similar? I have an extension but changed some of its code. I'm not sure if I would package it through my store OR do I log into my Magento Connect account and add the version there? I'm a newbie with extensions.
    Thank you in advance.

  8. #8
    Administrator david's Avatar
    Join Date
    Nov 2012
    Posts
    260
    Thanks
    23
    Thanked 40 Times in 33 Posts

    Default

    You can change the version in xml file and then package it again as you did

Tags for this Thread

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •