Github Local Setup

01 Jun 2022, 10:54

#1

Totally Zenned

Join Date:: Feb 2011
Posts:: 636
Plugin Contributions:: 0

Github Local Setup

I finally got my head around Git with the help of torvista and swguy. So I have a XAMPP server set up locally. I never considered the ability of using git commands just like MS-DOS! lol That is really EASY!

I have cloned my fork of Zencart to c:/xampp/htdocs/zencart that I want to do normal local development on. Actually installed stores will need to have config files added. Do you just copy the distro-config.php files in and NOT add them to git?

But I also want to be able to test on 1.5.7 where the database will be different. To me this means a different Head and different config files. So, this morning I cloned the same fork a second time c:/xampp/htdocs/zc157 so I can keep the config files (and databases) unique and the same. For this clone, I want to reset the head to 157. From what I read, this should work with some warnings about branch management. I do not think my branches will be that complex.

Is this viable?

01 Jun 2022, 16:18

#2

torvista

Totally Zenned

Join Date:: Aug 2007
Posts:: 2,850
Plugin Contributions:: 3

Re: Github Local Setup

I think that what I really want to know is how you can switch branches (ZC156/157/158) and get that current branch to use the correct database that was created the first time you used that branch to create a new Zen Cart.
A custom configure with case switch for versions?
Preventing the warnings for the admin and zc_install folder are done with constants in the admin:

define('ADMIN_BLOCK_WARNING_OVERRIDE', '1'); //bypasses checks in (admin) init_admin_auth to allow admin access when a) the admin folder has not been renamed and b) installer folder /zc_install exists.
define('WARN_INSTALL_EXISTENCE', 'false'); //bypasses check in (admin) init_errors: prevents a messageStack warning in the admin if the installer folder /zc_install exists.

files named "dev-whatever" are ignored by Git.

01 Jun 2022, 16:44

#3

carlwhat

Totally Zenned

Join Date:: Nov 2005
Posts:: 2,932
Plugin Contributions:: 5

Re: Github Local Setup

git is very powerful. and while you may think it may be easy, it is very easy to screwup.

files named "dev-whatever" are NOT ignored by git. files in the .gitignore file are ignored by git for that specific repo.

see:

https://github.com/zencart/zencart/blob/v158/.gitignore

one can also configure a global .gitignore for ones workstation which are not part of any specific repo.

someone who is new to git changing heads has problems written all over it (IMO). i would suggest reading up on changing branches.

good luck.

01 Jun 2022, 16:48

#4

g2ktcf

Totally Zenned

Join Date:: Feb 2011
Posts:: 636
Plugin Contributions:: 0

Re: Github Local Setup

carlwhat:
git is very powerful. and while you may think it may be easy, it is very easy to screwup.

files named "dev-whatever" are NOT ignored by git. files in the .gitignore file are ignored by git for that specific repo.

see:

https://github.com/zencart/zencart/blob/v158/.gitignore

one can also configure a global .gitignore for ones workstation which are not part of any specific repo.

someone who is new to git changing heads has problems written all over it (IMO). i would suggest reading up on changing branches.

good luck.

Carl that helps. I did not know that the configure.php files were ignored by Git and that was my problem! Thank you! I have been reading everything I can.

01 Jun 2022, 17:02

#5

g2ktcf

Totally Zenned

Join Date:: Feb 2011
Posts:: 636
Plugin Contributions:: 0

Re: Github Local Setup

torvista:
I think that what I really want to know is how you can switch branches (ZC156/157/158) and get that current branch to use the correct database that was created the first time you used that branch to create a new Zen Cart.
A custom configure with case switch for versions?

Yes, that is what I was concerned with. Now that I know configure.php is ignored based on .gitignore, this should be perfectly viable solution. I was worried about locally created files and how that worked with git.

02 Jun 2022, 08:47

#6

torvista

Totally Zenned

Join Date:: Aug 2007
Posts:: 2,850
Plugin Contributions:: 3

Re: Github Local Setup

files named "dev-whatever" are NOT ignored by git. files in the .gitignore file are ignored by git for that specific repo

Correct.
To clarify my lazy statement....dev-whatever files are ignored in the zencart repository as defined by an entry in the .gitignore file that is in the zencart repository:

dev-*.*

someone who is new to git changing heads has problems written all over it (IMO). i would suggest reading up on changing branches.

I've done plenty of reading, but it is not obvious to me what the pitfalls are of changing branches/HEAD are, in the context that is obvious to you?
Can you expand a little on this?
Thanks.

02 Jun 2022, 11:28

#7

carlwhat

Totally Zenned

Join Date:: Nov 2005
Posts:: 2,932
Plugin Contributions:: 5

Re: Github Local Setup

branches and HEAD are not the same thing.

creating and changing branches is part of the power of git.

resetting your HEAD puts you in a detached head state. i do not operate so well in said state.

@torvista you obviously have a process that works for you. but branches and HEAD are different. and being in a detached HEAD state one can lose all commits if a new commit is made on said state.

02 Jun 2022, 12:00

#8

g2ktcf

Totally Zenned

Join Date:: Feb 2011
Posts:: 636
Plugin Contributions:: 0

Re: Github Local Setup

Again, this Head question could well by my wording mistake on my part. So I have at least one clone of my fork that I can play with so

The goal was to be able to bring up an older version to test bug fixes on. Now this says "new" branch which bothers me a bit. Is this actually ZC157? And how are the different releases, A-D noted as they do not appear to be branches. Again, I am a total noob and am trying to tie all the bits I have read into a real workflow here.

Thank you all for you input and patience.

Chris

02 Jun 2022, 12:04

#9

swguy

Administrator

Join Date:: Feb 2006
Posts:: 10,620
Plugin Contributions:: 212

Re: Github Local Setup

> branches and HEAD are not the same thing.

Indeed, HEAD is a pointer to a commit.

> But I also want to be able to test on 1.5.7 where the database will be different.

If you REALLY want to do this, you'd be better off creating another folder. But remember that 1.5.7 is currently static and not scheduled to be changed anymore, so it doesn't make sense to use git to manage your view of the files - just pull the Zip of 1.5.7d and set it up.

Here's where branching and changing the current HEAD pointer DOES make sense: suppose @proseLA makes a fix that you want to test out.
You don't want to just merge it in to your current 1.5.8 because it might still change. So:
- create a new branch (and switch to that branch) using git checkout -b new-branch-name
- merge in @proseLA's change
- test
- revert back to the true 1.5.8 mainline by saying git checkout v158.
- (optionally) delete the branch new-branch-name.

02 Jun 2022, 12:19

#10

g2ktcf

Totally Zenned

Join Date:: Feb 2011
Posts:: 636
Plugin Contributions:: 0

Re: Github Local Setup

swguy:
> branches and HEAD are not the same thing.

Yes, that part is clear but was trying to figure out how to move backward

swguy:

If you REALLY want to do this, you'd be better off creating another folder. But remember that 1.5.7 is currently static and not scheduled to be changed anymore, so it doesn't make sense to use git to manage your view of the files - just pull the Zip of 1.5.7d and set it up.

And yes, this makes sense. Again, my brain wants to understand the workflow for all plausible issues and fixes.

Thanks!

02 Jun 2022, 15:43

#11

swguy

Administrator

Join Date:: Feb 2006
Posts:: 10,620
Plugin Contributions:: 212

Re: Github Local Setup

You certainly *can* move backward; I posted the workflow on the Zen Cart github in answer to your question there.

git checkout v157

The only trouble is that you'll have to keep fiddling with your configure.php files if you do this, since the databases differ between releases (158 vs 157).

02 Jun 2022, 16:20

#12

carlwhat

Totally Zenned

Join Date:: Nov 2005
Posts:: 2,932
Plugin Contributions:: 5

Re: Github Local Setup

swguy:
You certainly *can* move backward; I posted the workflow on the Zen Cart github in answer to your question there.

git checkout v157

The only trouble is that you'll have to keep fiddling with your configure.php files if you do this, since the databases differ between releases (158 vs 157).

i have not had problems using v157 code on v158 databases.

that's not to say they do not exist; i just have not had problems.

v156 and earlier represented problems due to the ezpages db reconfigure, from what i remember.

that said, i am sure that with a little bit of ingenuity, one could use the configure file to determine which codebase they are in, and then adjust to use the correct database so that these problems do not exist when one changes between branches.

best.

03 Jun 2022, 13:16

#13

g2ktcf

Totally Zenned

Join Date:: Feb 2011
Posts:: 636
Plugin Contributions:: 0

Re: Github Local Setup

swguy:
You certainly *can* move backward; I posted the workflow on the Zen Cart github in answer to your question there.

git checkout v157

The only trouble is that you'll have to keep fiddling with your configure.php files if you do this, since the databases differ between releases (158 vs 157).

:frusty: So true. I have it opened in Notepad++ and just forgot it was there! Crap. Thanks for the reminder.

03 Jun 2022, 15:09

#14

swguy

Administrator

Join Date:: Feb 2006
Posts:: 10,620
Plugin Contributions:: 212

Re: Github Local Setup

@carlwhat This thread is really not for experienced developers like you. It's for rookies. And my guidance to rookies would be, don't do this and expect it to work well in all circumstances.

Create a github repo to work on a single active branch (1.5.8 currently), and branch off that.

03 Jun 2022, 21:08

#15

mc12345678

Totally Zenned

Join Date:: Jul 2012
Posts:: 16,907
Plugin Contributions:: 1

Re: Github Local Setup

Wrote this a little while ago, but got interrupted. Seems to still apply and if not mistaken answers a related question either here or on a different related thread.

With my git software, I routinely retrieve the 1.5.7 (v157) github repo and then move my pointer for my local version to the current published version. This bypasses any merge conflicts that the team may have had to resolve. I also set local tags to the individual released versions which gives me an opportunity to see what differences have been made following a publicly released version. It does entail keeping up pointers to various areas in the distribution and recognizing what are things that were modified for all and what I may be doing locally.

As for configure.php files, I don't normally keep them in the repo as they can cause issues in applying to a chosen site or domain if not purposefully omitted when updating files to said server. Besides the zc_install process will normally generate those files with the format being comparable against the dist-configure.php version. Further if the fileset gets pushed to your online github, unless you have set those files to be ignored, then your credentials are publicly captured in a public repo. If the repo is private, of course the same concern doesn't exist.