Loading...
 

Tikiwiki-devel (mailman list mirror)


vendor migration explanations

posts: 126224 United Kingdom

Hi Jean-Marc

All good questions, i'll reply inline down there...

> On 5 Nov 2018, at 23:19, Jean-Marc Libs <jeanmarc.libs@gmail.com> wrote:
>
> Hi devs,
>
> Upon testing upgrades from Tiki 15 to tiki 19, I had a good look at vendor/autoload-disabled-README.txt as prompted by running sh setup.sh
> (I should have done this for Tiki18 but I had less time)
>
> These are the explanations I saw. Below, I have 2 questions in order to mak sure I understand
>
> Your vendor folder contains multiple packages that were normally bundled with Tiki. Since version 17 those libraries
> were migrated from the folder "vendor" to the folder "vendor_bundled".
>
> It looks like your instance still has these libraries in the vendor folder, to avoid issues your "vendor/autoload.php"
> was renamed to "vendor/autoload-disabled.php".
>
> If you are sure that want to use the libraries in addition to the ones bundled with tiki, please rename back your
> "vendor/autoload.php" and place a file with the name "do_not_clean.txt" in the vendor folder.
>
> Tiki will not load your "vendor/autoload.php" when is detected as being a stalled folder unless a file called
> "vendor/do_not_clean.txt" exists. That will also prevent, in future runs of composer, the automatic disabling of
> "vendor/autoload.php".
>
> Fist question:
> I see the instructions for " If you are sure that want to use the libraries in addition to the ones bundled with tiki " but why would I?

Maybe if you had added your own packages in there, like mPDF or something then you might need them. I guess it should say that maybe? Personally i always used something like vendor_custom for my custom additions due to running with svn checkouts, but i guess if you have a tarball install then using the default composer location for adding stuff might make sense?

> The instructions I miss are the one for the happy path: I am quite happy that all required packages are in vendor_bundled, so what do I do now?
> * " rm -rf vendor " ? Tiki still runs fine but I'm concerned the directory might not be recreated if I install additional packages later.
> * " rm -rf vendor/* " ?

I guess if there's nothing in there you need deleting it makes sense, setup.sh will remake it and set the perms right so you can use the new package manager to install what you need in there afterwards.

> Second question very short question:
> " stalled folder " should read " stale folder ", shouldn't it?

Not sure, neither word makes great sense to me... i guess i didn't read it properly! :-)

jb


>
> Cheers,
> Jyhem
> ___
> TikiWiki-devel mailing list
> TikiWiki-devel at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel



___
TikiWiki-devel mailing list
TikiWiki-devel at lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel

Hi Jonny,

I did more testing and experimenting. The status quo was not good because
following the instructions left an annoying alert box in the admin panel
which was complaining about the vendor directory content.
Therefore, I added instructions for completing the process for people who
don't master composer. Which is probably a big proportion of Tiki users.
Committed revision 68335. & 68336.


I reply inline.

On Tue, Nov 6, 2018 at 11:23 AM Jonny Bradley <jonny@tiki.org> wrote:

> Hi Jean-Marc
>
> All good questions, i'll reply inline down there...
>
> > On 5 Nov 2018, at 23:19, Jean-Marc Libs <jeanmarc.libs@gmail.com> wrote:
> >
> > Hi devs,
> >
> > Upon testing upgrades from Tiki 15 to tiki 19, I had a good look at
> vendor/autoload-disabled-README.txt as prompted by running sh setup.sh
> > (I should have done this for Tiki18 but I had less time)
> >
> > These are the explanations I saw. Below, I have 2 questions in order to
> mak sure I understand
> >
> > Your vendor folder contains multiple packages that were normally bundled
> with Tiki. Since version 17 those libraries
> > were migrated from the folder "vendor" to the folder "vendor_bundled".
> >
> > It looks like your instance still has these libraries in the vendor
> folder, to avoid issues your "vendor/autoload.php"
> > was renamed to "vendor/autoload-disabled.php".
> >
> > If you are sure that want to use the libraries in addition to the ones
> bundled with tiki, please rename back your
> > "vendor/autoload.php" and place a file with the name "do_not_clean.txt"
> in the vendor folder.
> >
> > Tiki will not load your "vendor/autoload.php" when is detected as being
> a stalled folder unless a file called
> > "vendor/do_not_clean.txt" exists. That will also prevent, in future runs
> of composer, the automatic disabling of
> > "vendor/autoload.php".
> >
> > Fist question:
> > I see the instructions for " If you are sure that want to use the
> libraries in addition to the ones bundled with tiki " but why would I?
>
> Maybe if you had added your own packages in there, like mPDF or something
> then you might need them. I guess it should say that maybe? Personally i
> always used something like vendor_custom for my custom additions due to
> running with svn checkouts, but i guess if you have a tarball install then
> using the default composer location for adding stuff might make sense?
>

That was more a rethorical question. Meaning most people will be in the
situation same sitaution as I was where they never installed anything extra
in "vendors" and couldn't have figured out how to do it if the idea came to
them.
Hopefully now it's easier with the Tiki stuff out of the way in
vendors_bundled.

Anyway, the most common situation was the one for which we provided no
instructions. And doing nothing is not an option either, because it gets
you an annoying alert box in the admin panel.

> The instructions I miss are the one for the happy path: I am quite happy
> that all required packages are in vendor_bundled, so what do I do now?
> > * " rm -rf vendor " ? Tiki still runs fine but I'm concerned the
> directory might not be recreated if I install additional packages later.
> > * " rm -rf vendor/* " ?
>
> I guess if there's nothing in there you need deleting it makes sense,
> setup.sh will remake it and set the perms right so you can use the new
> package manager to install what you need in there afterwards.
>

I tested the " m -rf vendor/* " and it works just fine.
I explained this in the instructions and committed them for 19.x and 18.x
(17.x is unsupported now and not meant to be installed now).


> > Second question very short question:
> > " stalled folder " should read " stale folder ", shouldn't it?
>
> Not sure, neither word makes great sense to me... i guess i didn't read it
> properly! :-)
>
> I hope it's better now, read it again :-)

Cheers,
Jyhem


Why Register?

Register at tiki.org and you'll be able to use the account at any *.tiki.org site, thanks to the InterTiki feature. A valid email address is required to receive site notifications and occasional newsletters. You can opt out of these items at any time.