Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update drupal-composer/drupal-scaffold from 2.2.0 to 2.3.0 #9

Open
wants to merge 4 commits into
base: source
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .beetbox/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
host.config.yml
local.config.yml
Vagrantfile
Vagrantfile.local
5 changes: 5 additions & 0 deletions .beetbox/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
vagrant_memory: 2048
beet_domain: drupal-project.local
beet_project: custom
beet_web: "/var/beetbox/"
8 changes: 8 additions & 0 deletions .beetbox/tasks/post/disable-xdebug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
- name: Disable xdebug.
file:
path: "/etc/php/{{ php_version }}/fpm/conf.d/20-xdebug.ini"
state: absent
notify:
- restart webserver
- restart php-fpm
1 change: 1 addition & 0 deletions .composer/cache/.htaccess
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Deny from all
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,8 @@

# Ignore files generated by PhpStorm
/.idea/

# Extra.
web/
.composer/
Vagrantfile
17 changes: 17 additions & 0 deletions .gitignore.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Ignore sensitive information
/web/sites/*/settings.php
/web/sites/*/settings.local.php

# Ignore Drupal's file directory
/web/sites/*/files/

# Ignore SimpleTest multi-site environment.
/web/sites/simpletest

# Ignore files generated by PhpStorm
/.idea/

# Extra.
.beetbox/
.composer/
Vagrantfile
13 changes: 13 additions & 0 deletions .htaccess
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#
# Redirect all requests to the web directory.
#

<IfModule mod_rewrite.c>
RewriteEngine On

RewriteCond %{REQUEST_URI} ^/composer [NC,OR]
RewriteCond %{REQUEST_URI} ^/composer.php$
RewriteRule ^ composer.php [L]

RewriteRule ^(.*)$ /web/$1 [L]
</IfModule>
164 changes: 40 additions & 124 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,131 +1,47 @@
# Composer template for Drupal projects
# Disclaimer

[![Build Status](https://travis-ci.org/drupal-composer/drupal-project.svg?branch=8.x)](https://travis-ci.org/drupal-composer/drupal-project)
First off I'd like to say this not an ideal solution and should never be considered as an alternative to using composer via CLI.

This project template should provide a kickstart for managing your site
dependencies with [Composer](https://getcomposer.org/).
We're in an awkward situtation where composer is becoming a hard requirement for Drupal. If all this project achieves is more awareness of the proplem and convinces composer naysayers that it's actually better to use composer CLI, I'd be happy.

If you want to know how to use it as replacement for
[Drush Make](https://github.com/drush-ops/drush/blob/master/docs/make.md) visit
the [Documentation on drupal.org](https://www.drupal.org/node/2471553).
However, I understand that there are some cases where composer via CLI might be technically impossible leaving some users behind and the only option would be to use another CMS.

## Usage
To be clear, it would still be better to address the educational / technical limitations.

First you need to [install composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx).
Currently, this is just a proof of concept and is very insecure and should not be used on any externally accessible webserver.

> Note: The instructions below refer to the [global composer installation](https://getcomposer.org/doc/00-intro.md#globally).
You might need to replace `composer` with `php composer.phar` (or similar)
for your setup.
It would be nice if this could be integrated into Drupal's existing authentication and only allow access to user 1 similar to `update.php`.

After that you can create the project:

```
composer create-project drupal-composer/drupal-project:8.x-dev some-dir --stability dev --no-interaction
```

With `composer require ...` you can download new dependencies to your
installation.

```
cd some-dir
composer require drupal/devel:~1.0
```

The `composer create-project` command passes ownership of all files to the
project that is created. You should create a new git repository, and commit
all files not excluded by the .gitignore file.

## What does the template do?

When installing the given `composer.json` some tasks are taken care of:

* Drupal will be installed in the `web`-directory.
* Autoloader is implemented to use the generated composer autoloader in `vendor/autoload.php`,
instead of the one provided by Drupal (`web/vendor/autoload.php`).
* Modules (packages of type `drupal-module`) will be placed in `web/modules/contrib/`
* Theme (packages of type `drupal-theme`) will be placed in `web/themes/contrib/`
* Profiles (packages of type `drupal-profile`) will be placed in `web/profiles/contrib/`
* Creates default writable versions of `settings.php` and `services.yml`.
* Creates `web/sites/default/files`-directory.
* Latest version of drush is installed locally for use at `vendor/bin/drush`.
* Latest version of DrupalConsole is installed locally for use at `vendor/bin/drupal`.

## Updating Drupal Core

This project will attempt to keep all of your Drupal Core files up-to-date; the
project [drupal-composer/drupal-scaffold](https://github.com/drupal-composer/drupal-scaffold)
is used to ensure that your scaffold files are updated every time drupal/core is
updated. If you customize any of the "scaffolding" files (commonly .htaccess),
you may need to merge conflicts if any of your modified files are updated in a
new release of Drupal core.

Follow the steps below to update your core files.

1. Run `composer update drupal/core --with-dependencies` to update Drupal Core and its dependencies.
1. Run `git diff` to determine if any of the scaffolding files have changed.
Review the files for any changes and restore any customizations to
`.htaccess` or `robots.txt`.
1. Commit everything all together in a single commit, so `web` will remain in
sync with the `core` when checking out branches or running `git bisect`.
1. In the event that there are non-trivial conflicts in step 2, you may wish
to perform these steps on a branch, and use `git merge` to combine the
updated core files with your customized files. This facilitates the use
of a [three-way merge tool such as kdiff3](http://www.gitshah.com/2010/12/how-to-setup-kdiff-as-diff-tool-for-git.html). This setup is not necessary if your changes are simple;
keeping all of your modifications at the beginning or end of the file is a
good strategy to keep merges easy.

## Generate composer.json from existing project

With using [the "Composer Generate" drush extension](https://www.drupal.org/project/composer_generate)
you can now generate a basic `composer.json` file from an existing project. Note
that the generated `composer.json` might differ from this project's file.


## FAQ

### Should I commit the contrib modules I download?

Composer recommends **no**. They provide [argumentation against but also
workrounds if a project decides to do it anyway](https://getcomposer.org/doc/faqs/should-i-commit-the-dependencies-in-my-vendor-directory.md).

### Should I commit the scaffolding files?

The [drupal-scaffold](https://github.com/drupal-composer/drupal-scaffold) plugin can download the scaffold files (like
index.php, update.php, …) to the web/ directory of your project. If you have not customized those files you could choose
to not check them into your version control system (e.g. git). If that is the case for your project it might be
convenient to automatically run the drupal-scaffold plugin after every install or update of your project. You can
achieve that by registering `@drupal-scaffold` as post-install and post-update command in your composer.json:

```json
"scripts": {
"drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
"post-install-cmd": [
"@drupal-scaffold",
"..."
],
"post-update-cmd": [
"@drupal-scaffold",
"..."
]
},
```
### How can I apply patches to downloaded modules?

If you need to apply patches (depending on the project being modified, a pull
request is often a better solution), you can do so with the
[composer-patches](https://github.com/cweagans/composer-patches) plugin.

To add a patch to drupal module foobar insert the patches section in the extra
section of composer.json:
```json
"extra": {
"patches": {
"drupal/foobar": {
"Patch description": "URL to patch"
}
}
}
```
### How do I switch from packagist.drupal-composer.org to packages.drupal.org?

Follow the instructions in the [documentation on drupal.org](https://www.drupal.org/docs/develop/using-composer/using-packagesdrupalorg).
# What?

This project provides a way to run common composer commands via a browser.

# How?

It creates a simple endpoint that will run a command on the project codebase.

eg. `/composer/update/drupal/core/--/with-dependencies` would run `composer update drupal/core --with-dependencies`.

# limitations.

Due to memory limitations it is unlikely you'd be able to run `install` to install all dependencies, also an unfiltered `update` would be impossible.
However, if you include most packages in the tarball you don't have to install all packages and `require` or `update` on single packages are possible.

# Request structure.

/composer/[command]/[argument]/--/[options]

# Examples.

`/composer/validate` (default)

`/composer/show`

`/composer/require/drupal/devel/--/prefer-dist`

`/composer/install`

`/composer/install/--/no-dev`

`/composer/update/drupal/core/--/with-dependencies`

18 changes: 18 additions & 0 deletions circle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
machine:
php:
version: 7.1.0
dependencies:
override:
- composer self-update
- composer install --prefer-dist
- rm .gitignore && mv .gitignore.dist .gitignore
- find ./vendor -type d | grep .git | xargs rm -rf
- find ./web -type d | grep .git | xargs rm -rf
- git config --global user.email "[email protected]"
- git config --global user.name "Circle CI"
- git add -A && git commit -m"[skip ci] Build of $CIRCLE_SHA1"
- git push origin $CIRCLE_BRANCH:build --force
test:
override:
- composer validate
7 changes: 5 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,18 @@
}
],
"require": {
"composer/composer": "^1.4",
"composer/installers": "^1.2",
"cweagans/composer-patches": "^1.6",
"drupal-composer/drupal-scaffold": "^2.2",
"drupal-composer/drupal-scaffold": "2.3.0",
"drupal/console": "~1.0",
"drupal/core": "~8.0",
"drush/drush": "~8.0",
"webflo/drupal-finder": "^0.2.1",
"webmozart/path-util": "^2.3"
},
"require-dev": {
"beet/box": "^0.5.1",
"behat/mink": "~1.7",
"behat/mink-goutte-driver": "~1.2",
"jcalderonzumba/gastonjs": "~1.0.2",
Expand All @@ -44,7 +46,8 @@
},
"autoload": {
"classmap": [
"scripts/composer/ScriptHandler.php"
"scripts/composer/ScriptHandler.php",
"scripts/composer/WebComposer.php"
]
},
"scripts": {
Expand Down
Loading