forked from Islandora-Devops/isle-dc
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #348 from jhu-idc/incremental_updates_94
Add temp CI steps for the incremental updater
- Loading branch information
Showing
43 changed files
with
2,547 additions
and
38,578 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,75 +1,180 @@ | ||
| <img alt="Drupal Logo" src="https://www.drupal.org/files/Wordmark_blue_RGB.png" height="60px"> | ||
| # Drupal Project | ||
|
|
||
| Drupal is an open source content management platform supporting a variety of | ||
| websites ranging from personal weblogs to large community-driven websites. For | ||
| more information, visit the Drupal website, [Drupal.org][Drupal.org], and join | ||
| the [Drupal community][Drupal community]. | ||
| [](https://php.net/) | ||
| [](https://travis-ci.com/Islandora/islandora) | ||
| [](./CONTRIBUTING.md) | ||
| [](./LICENSE) | ||
|
|
||
| ## Contributing | ||
| ## Introduction | ||
| This project template provides a starter kit for managing your site | ||
| dependencies with [Composer](https://getcomposer.org/). | ||
|
|
||
| Drupal is developed on [Drupal.org][Drupal.org], the home of the international | ||
| Drupal community since 2001! | ||
| Fork of [drupal-composer/drupal-project](https://github.com/drupal-composer/drupal-project) used to pin down Drupal core versions | ||
| for [islandora-playbook](https://github.com/Islandora-Devops/islandora-playbook). | ||
|
|
||
| [Drupal.org][Drupal.org] hosts Drupal's [GitLab repository][GitLab repository], | ||
| its [issue queue][issue queue], and its [documentation][documentation]. Before | ||
| you start working on code, be sure to search the [issue queue][issue queue] and | ||
| create an issue if your aren't able to find an existing issue. | ||
| ## Requirements | ||
|
|
||
| Every issue on Drupal.org automatically creates a new community-accessible fork | ||
| that you can contribute to. Learn more about the code contribution process on | ||
| the [Issue forks & merge requests page][issue forks]. | ||
| [Composer](https://getcomposer.org/) is required to use `drupal-project`. | ||
|
|
||
| ## Usage | ||
| ## Installation | ||
|
|
||
| For a brief introduction, see [USAGE.txt](/core/USAGE.txt). You can also find | ||
| guides, API references, and more by visiting Drupal's [documentation | ||
| page][documentation]. | ||
| `$ composer create-project islandora/drupal-project` | ||
|
|
||
| You can quickly extend Drupal's core feature set by installing any of its | ||
| [thousands of free and open source modules][modules]. With Drupal and its | ||
| module ecosystem, you can often build most or all of what your project needs | ||
| before writing a single line of code. | ||
| ## Documentation | ||
|
|
||
| ## Changelog | ||
| Further documentation for this module is available on the [Islandora 8 documentation site](https://islandora.github.io/documentation/). | ||
|
|
||
| Drupal keeps detailed [change records][changelog]. You can search Drupal's | ||
| changes for a record of every notable breaking change and new feature since | ||
| 2011. | ||
| ## Troubleshooting/Issues | ||
|
|
||
| ## Security | ||
| Having problems or solved a problem? Check out the Islandora google groups for a solution. | ||
|
|
||
| For a list of security announcements, see the [Security advisories | ||
| page][Security advisories] (available as [an RSS feed][security RSS]). This | ||
| page also describes how to subscribe to these announcements via email. | ||
| * [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora) | ||
| * [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev) | ||
|
|
||
| For information about the Drupal security process, or to find out how to report | ||
| a potential security issue to the Drupal security team, see the [Security team | ||
| page][security team]. | ||
| ## Maintainers | ||
|
|
||
| ## Need a helping hand? | ||
| Current maintainers: | ||
|
|
||
| Visit the [Support page][support] or browse [over a thousand Drupal | ||
| providers][service providers] offering design, strategy, development, and | ||
| hosting services. | ||
| * [Danny Lamb](https://github.com/dannylamb) | ||
|
|
||
| ## Legal matters | ||
| ## Development | ||
|
|
||
| Know your rights when using Drupal by reading Drupal core's | ||
| [license](/core/LICENSE.txt). | ||
| If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora/documentation/wiki). We love to hear from you! | ||
|
|
||
| Learn about the [Drupal trademark and logo policy here][trademark]. | ||
| If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) pages on Islandora.ca for more information. | ||
|
|
||
| [Drupal.org]: https://www.drupal.org | ||
| [Drupal community]: https://www.drupal.org/community | ||
| [GitLab repository]: https://git.drupalcode.org/project/drupal | ||
| [issue queue]: https://www.drupal.org/project/issues/drupal | ||
| [issue forks]: https://www.drupal.org/drupalorg/docs/gitlab-integration/issue-forks-merge-requests | ||
| [documentation]: https://www.drupal.org/documentation | ||
| [changelog]: https://www.drupal.org/list-changes/drupal | ||
| [modules]: https://www.drupal.org/project/project_module | ||
| [security advisories]: https://www.drupal.org/security | ||
| [security RSS]: https://www.drupal.org/security/rss.xml | ||
| [security team]: https://www.drupal.org/drupal-security-team | ||
| [service providers]: https://www.drupal.org/drupal-services | ||
| [support]: https://www.drupal.org/support | ||
| [trademark]: https://www.drupal.com/trademark | ||
| We recommend using the [islandora-playbook](https://github.com/Islandora-Devops/islandora-playbook) to get started. | ||
|
|
||
| ## License | ||
|
|
||
| [GPLv2](http://www.gnu.org/licenses/gpl-2.0.txt) | ||
| > 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. | ||
|
|
||
| After that you can create the project: | ||
|
|
||
| ``` | ||
| composer create-project drupal-composer/drupal-project:8.x-dev some-dir --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`. | ||
| * Creates environment variables based on your .env file. See [.env.example](.env.example). | ||
|
|
||
| ## Updating Drupal Core | ||
|
|
||
| This project will attempt to keep all of your Drupal Core files up-to-date; the | ||
| project [drupal/core-composer-scaffold](https://github.com/drupal/core-composer-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 drupal/core-dev --with-dependencies` to update Drupal Core and its dependencies. | ||
| 2. 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 Composer Scaffold](https://github.com/drupal/core-composer-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 `@composer drupal:scaffold` as post-install and post-update command in your composer.json: | ||
|
|
||
| ```json | ||
| "scripts": { | ||
| "post-install-cmd": [ | ||
| "@composer drupal:scaffold", | ||
| "..." | ||
| ], | ||
| "post-update-cmd": [ | ||
| "@composer 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 or local path 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). | ||
|
|
||
| ### How do I specify a PHP version ? | ||
|
|
||
| This project supports PHP 7.0 as minimum version (see [Drupal 8 PHP requirements](https://www.drupal.org/docs/8/system-requirements/drupal-8-php-requirements)), however it's possible that a `composer update` will upgrade some package that will then require PHP 7+. | ||
|
|
||
| To prevent this you can add this code to specify the PHP version you want to use in the `config` section of `composer.json`: | ||
| ```json | ||
| "config": { | ||
| "sort-packages": true, | ||
| "platform": { | ||
| "php": "7.0.33" | ||
| } | ||
| }, | ||
| ``` |
Oops, something went wrong.