[#20059] - [4.0] Removing the libraries/vendor folder
- Fixed in Code Base
- 12 Apr 2018
- Medium
- Build: 4.0-dev
- # 20059
- Diff
- rdeutz:remove_vendor_folder
User tests: Successful: Unsuccessful:
Current situation
Our libraries/vendor folder contains all 3rd part packages Joomla! depends on. This gives us a lot of headache when it comes to updating stuff or requesting packages e.g. for testing. A simple composer require will update also unrelated packages and you get hundreds of changes in PR.
We discussed the situation in different groups and voted in the production department on removing the folder contends. The voting passed with a majority so we are going to remove the folder in 4.0-dev soon. To be clear this doesn't effect the 3.x series of Joomla!
A direct impact of this change is that people can't clone the repository and have an installable Joomla! They have to make one additional step "composer install" and then they are good to go. We understand that this might be a burden for some people and that we have to explain what are the steps before and after cloning a repository. On the other side, git isn't a software distribution channel and this only infects the core and extension development. For testing and all other things we can use nightly builds or releases on download.joomla.org.
ToDo
[ ] Publishing a article on developer.joomla.org and explaining the situation
[ ] Writing documentation on docs.joomla.org
[ ] Fix the nightly build script
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Repository External Library Libraries Composer Change |
For testing and all other things we can use nightly builds or releases on download.joomla.org.
I thought that implied the build scripts/workflows for all build types (tagged release packages and nightlies) would all be updated appropriately
sorry I missed the final line - mea culpa
out if interest how do other projects manage this
Concrete5, OctoberCMS, Grav, and Drupal all use Composer in core and do not check the vendor directory into their VCS.
I guess I misunderstood this folder then https://github.com/drupal/drupal/tree/8.6.x/core/assets/vendor
That's UI dependencies that NPM is used to manage. Composer strictly covers PHP dependencies.
i guessed correctly then :)
Although this PR is touching only the PHP vendors I would like to add here a note about the javascript vendors:
The reduction on lines of our repos actual code is far more dramatic for javascript:
With media/vendor
Without
A reminder here: neither any of the files belonging to libraries/vendors or media/vendor should ever changed in our repo, so removing them also prevents such behaviours.
While I agree with Dimitries that removing other "vendor" directories makes sense, I would like to keep this on the PHP level. This PR implements what we have agreed on in the production department. Other vendor directories would need another voting and PR :-)
| Labels |
Added:
?
?
|
||
Are the build scripts, etc. updated to work with this change, or will they break after merge?
If you do a composer install before running the build script anything should work.
Side note: We (automated testing team) are working on consolidation of our robo scripts and the plan is to have the build script moved to robo scripts. So we can provide ONE interface for build, develop and testing.
@rdeutz I think Allon meant that there needs to be adjustments to tne nightly script so that composer install is executed. Otherwise the nightlies will be broken.
I'm also wondering: Currently we "remove" quite a few files (eg test folders) using the .gitignore file. How do we make sure they now don't end up in the distributed package?
Fix the nightly build script
If #19848 ever gets merged then the nightly build script would (finally) be able to use the same packaging script that is used for tagged releases. So build.php should be updated as part of this pull request with whatever changes are required to be able to build a package, I will adjust how the nightlies are built based on that as I have done for every other change implemented in the build script.
And now the staging and 3.9 build jobs use the modified script. Just need to get that merged up to 4.0, have fun in git merge hell George
We can cherry pick that commit if needed.
It's no rush. The old faithful hacked up build script will continue to suffice until this PR is merged. It'll just make my life more sane if I only have to update the 4.0-nightly.sh file one last time to point to our packager friendly build.php file instead of my hacked to all bits and supporting way too many paths build-jenkins.php file
| Status | Pending | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2018-04-12 13:01:16 |
| Closed_By | ⇒ | laoneo |
This really should not have been merged as there were still three outstanding todo items in the original post and it didnt have any successful user tests.
Please can this be reverted UNTIL the todo items have been completed as they severely impact any testing
I have to say this publicly. You pulled the trigger too early on this. com_patchtester is now unusable on vendor related PRs (i.e. the database stuff). The GSoC PR testing platform is not yet available. The nightly builds update is not a 30 second task (it's actually about 15 minutes but AFAIK I'm the only one who knows how that's running at the moment and it's going to be a little rude to drop the conference for this). Essentially, right now unless you're a coder you can't test patches on the 4.0 branch. This PR isn't an issue, but the fact that it was done so prematurely is very problematic.
I dont know what the rush was to merge this. Or why procedures were broken to merge this
Reverted, was a misunderstanding. Sorry for that.
Does that mean there will no longer be a nightly install OR will the script that makes that be updated to do the composer install