Results 1 to 8 of 8
  1. #1
    Join Date
    Jun 2007
    Location
    Bronx, New York, United States
    Posts
    677
    Plugin Contributions
    8

    Default Versioning of an Encapsulated Module

    I wanted to know what exactly is the practice of versioning of an encapsulated module.

    Should only the files that were changed be included in that versions directory or should all files of the module, regardless if changed or not, be included?

  2. #2
    Join Date
    Feb 2006
    Location
    Tampa Bay, Florida
    Posts
    10,278
    Plugin Contributions
    125

    Default Re: Versioning of an Encapsulated Module

    Each version needs to be complete, with all required files.
    That Software Guy. My Store: Zen Cart Support
    Available for hire - See my ad in Services
    Plugin Moderator, Documentation Curator, Chief Cook and Bottle-Washer.
    Do you benefit from Zen Cart? Then please support the project.

  3. #3
    Join Date
    Jul 2012
    Posts
    16,797
    Plugin Contributions
    17

    Default Re: Versioning of an Encapsulated Module

    Then either through instruction or new version action the next version should also be able to address the upgrade action preferably without failing because of the previous version.
    ZC Installation/Maintenance Support <- Site
    Contribution for contributions welcome...

  4. #4
    Join Date
    Sep 2009
    Location
    Stuart, FL
    Posts
    13,328
    Plugin Contributions
    94

    Default Re: Versioning of an Encapsulated Module

    Quote Originally Posted by mc12345678 View Post
    Then either through instruction or new version action the next version should also be able to address the upgrade action preferably without failing because of the previous version.
    That, IMO, goes without saying.

  5. #5
    Join Date
    Jul 2012
    Posts
    16,797
    Plugin Contributions
    17

    Default Re: Versioning of an Encapsulated Module

    Quote Originally Posted by lat9 View Post
    That, IMO, goes without saying.
    IMO, all of this does. The answers are all a matter of preference and opinion. There's nothing of requirement in any of it. Do what you want or see best.

    If others don't like what is created they'll just do things differently to get the result they want.

    This is the way.
    ZC Installation/Maintenance Support <- Site
    Contribution for contributions welcome...

  6. #6
    Join Date
    Jun 2007
    Location
    Bronx, New York, United States
    Posts
    677
    Plugin Contributions
    8

    Default Re: Versioning of an Encapsulated Module

    Quote Originally Posted by swguy View Post
    Each version needs to be complete, with all required files.
    So if I released say version 1.0.0 with a directory v1.0.0 and place that into the ZenCart plugins or a GitHub, couldn't I just rename that directory into version 1.1.0 release that in the plugins and GitHub?

    In theory, the Plugins Directory and GitHub still have all the historical versions so if there is a problem with the newer version, the step back version can still be used?

  7. #7
    Join Date
    Sep 2009
    Location
    Stuart, FL
    Posts
    13,328
    Plugin Contributions
    94

    Default Re: Versioning of an Encapsulated Module

    Quote Originally Posted by retched View Post
    So if I released say version 1.0.0 with a directory v1.0.0 and place that into the ZenCart plugins or a GitHub, couldn't I just rename that directory into version 1.1.0 release that in the plugins and GitHub?

    In theory, the Plugins Directory and GitHub still have all the historical versions so if there is a problem with the newer version, the step back version can still be used?
    Yep. FWIW, I start with the version-directory rename (so that existing files transition over to the new sub-directory) as one commit and then make the next-version updates on top of that.

  8. #8
    Join Date
    Jul 2012
    Posts
    16,797
    Plugin Contributions
    17

    Default Re: Versioning of an Encapsulated Module

    Quote Originally Posted by retched View Post
    So if I released say version 1.0.0 with a directory v1.0.0 and place that into the ZenCart plugins or a GitHub, couldn't I just rename that directory into version 1.1.0 release that in the plugins and GitHub?

    In theory, the Plugins Directory and GitHub still have all the historical versions so if there is a problem with the newer version, the step back version can still be used?
    Quote Originally Posted by lat9 View Post
    Yep. FWIW, I start with the version-directory rename (so that existing files transition over to the new sub-directory) as one commit and then make the next-version updates on top of that.
    For example the manifest.php file would need updating. An example of such is here: https://docs.zen-cart.com/dev/plugin...manifest-files
    Even though that example doesn't align with the file structure folder name above it. E.g. file is stored under version 1.0.0 but the manifest shows version 3.0.0.
    ZC Installation/Maintenance Support <- Site
    Contribution for contributions welcome...

 

 

Similar Threads

  1. Encapsulated Plugins - Payment modules
    By niccol in forum Code Collaboration
    Replies: 2
    Last Post: 2 Feb 2022, 09:47 PM
  2. v157 Encapsulated Plugins
    By niccol in forum Bug Reports
    Replies: 6
    Last Post: 22 Jul 2021, 05:53 PM
  3. [Proposed] Versioning Guidelines
    By dreamscape in forum Contribution-Writing Guidelines
    Replies: 0
    Last Post: 27 Feb 2007, 12:08 AM

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
  •  
disjunctive-egg
Zen-Cart, Internet Selling Services, Klamath Falls, OR