Zen Cart Logo
Forums / All Other Contributions/Addons / Linking your contribution to a Github Repository

Linking your contribution to a Github Repository

Sticky

Views: 5,357

Results 1 to 7 of 7
31 May 2018, 6:44 PM
#1
swguy avatar

swguy

Administrator

Join Date:
Feb 2006
Location:
Tampa Bay, Florida
Posts:
10,695
Plugin Contributions:
56

Linking your contribution to a Github Repository

The Zen Cart plugins area now allows you to enter the Github repo for your contribution, if you are storing it in Github. Just enter

<your github username>/<your repo name>

in the Github Repository field. As an example, Better Together has "scottcwilson/zen_cart_better_together" in the Github Repository field.

You can see an example of the "Github Repository" button here:

https://www.zen-cart.com/downloads.php?do=file&id=126

If you want to add a Github repo to an existing contribution that you support, just send your humble moderator a PM. :)

8 May 2020, 10:13 AM
#2
torvista avatar

torvista

Totally Zenned

Join Date:
Aug 2007
Location:
Gijón, Asturias, Spain
Posts:
2,872
Plugin Contributions:
7

Re: Linking your contribution to a Github Repository

Is it possible to remove the download of the plugin (obsolete/static) code entirely and only have the link to the (current/up-to-date) GitHub code?

8 May 2020, 11:08 AM
#3
mc12345678 avatar

mc12345678

Totally Zenned

Join Date:
Jul 2012
Posts:
16,908
Plugin Contributions:
2

Re: Linking your contribution to a Github Repository

torvista:

Is it possible to remove the download of the plugin (obsolete/static) code entirely and only have the link to the (current/up-to-date) GitHub code?
Hi torvista, neighborhood pain in your back side here. :) can you explain why? It's my understanding that having access to the old versions provides a benefit to those that have either previously downloaded the software and/or as a point of reference as to what has changed. Further, unfortunately to an extent, github "history" can be changed through force pushes making it possible (though perhaps not desirable) to change a historical version compared to the saved, accessible version on this site...

8 May 2020, 12:53 PM
#4
swguy avatar

swguy

Administrator

Join Date:
Feb 2006
Location:
Tampa Bay, Florida
Posts:
10,695
Plugin Contributions:
56

Re: Linking your contribution to a Github Repository

As @mc12345678 notes, the preservation of past history (in an immutable state) can be very valuable.

There are a couple of other flaws in this idea:

  • Github repos are not necessarily kept in a releasable state at all times. People frequently check in work-in-progress.
  • The submission and review process ensures that mods available from the plugins page have been checked for malware, advertising, phone-home schemes and various other undesirable things.
9 May 2020, 5:10 PM
#5
drbyte avatar

drbyte

Sensei

Join Date:
Jan 2004
Posts:
63,513
Plugin Contributions:
176

Re: Linking your contribution to a Github Repository

Correct. It was done this way to specifically allow for some degree of curation, and to create an archive in case someone deletes their github repo or changes it.
Plus, you'll likely be posting something to forum users' support thread as well, so the extra minute to upload the file becomes part of that workflow.

9 May 2020, 6:23 PM
#6
swguy avatar

swguy

Administrator

Join Date:
Feb 2006
Location:
Tampa Bay, Florida
Posts:
10,695
Plugin Contributions:
56

Re: Linking your contribution to a Github Repository

The github repo button is not so much there to allow you to pull a copy of the contrib as it is for you to contribute PRs, open issue reports, or contribute in some other way. It takes a village to maintain a plugin. :)

9 May 2020, 9:24 PM
#7
torvista avatar

torvista

Totally Zenned

Join Date:
Aug 2007
Location:
Gijón, Asturias, Spain
Posts:
2,872
Plugin Contributions:
7

Re: Linking your contribution to a Github Repository

ok, I'm convinced :cool: