From a115517dba03b744d15b115e46e595012cf1c22b Mon Sep 17 00:00:00 2001 From: Bec White Date: Tue, 20 Nov 2018 17:34:11 -0600 Subject: [PATCH 1/5] Add info on how to run the-build for development. --- docs/development.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/development.md diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 00000000..940e6c79 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,31 @@ +# Developing on the-build + +To develop and test changes to the-build, you'll generally need to have a Drupal codebase to run the-build on. + +1. Choose a site to test against +2. Check out the-build as a git repository into the site's `vendor/` directory +3. Make, commit, and push your changes from within `vendor/palantirnet/the-build/` + +The major thing to watch out for here is that your copy of the-build is temporary -- in certain cases (especially when switching branches) when you run composer commands, your repo may be replaced with a different version. + +## Testing on an existing site + +You can clone the-build into the vendor directory of an existing site. If it doesn't have a version of the-build already installed, you'll need to require it with `composer require palantirnet/the-build:dev-release-2.0` first. + +``` +cd my-site +composer require palantirnet/the-build:dev-release-2.0 --prefer-source +``` + +At this point, `vendor/palantirnet/the-build` should be a clone of `git@github.com:palantirnet/the-build.git`. + +## Creating a new site for testing + +Follow the [Quick Start guide for palantirnet/drupal-skeleton](https://github.com/palantirnet/drupal-skeleton#quick-start). Before installing the-build in step 3, update the required version of the-build: + +``` +composer require palantirnet/the-build:dev-release-2.0 --prefer-source +``` + +---- +Copyright 2018 Palantir.net, Inc. From 8ecf2615fb0fc391b4566f0576772d459a3800f8 Mon Sep 17 00:00:00 2001 From: Bec White Date: Tue, 20 Nov 2018 17:46:56 -0600 Subject: [PATCH 2/5] Add link to the README. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index fb7fa00f..6cfaf4de 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ Configure your build by editing `.the-build/build.default.properties.yml`. You c * [Building an artifact](docs/artifacts.md) * [Using Drupal multisites](docs/drupal_multisite.md) * [Custom tasks provided by the-build](docs/tasks.md) +* [Developing on the-build](docs/development.md) ---- Copyright 2016, 2017, 2018 Palantir.net, Inc. From d61527a48dac743173a6d7e2f9e6feecfbb28356 Mon Sep 17 00:00:00 2001 From: Avi Schwab Date: Mon, 26 Nov 2018 14:30:01 -0600 Subject: [PATCH 3/5] Add checkout info --- docs/development.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/development.md b/docs/development.md index 940e6c79..67f9ce7b 100644 --- a/docs/development.md +++ b/docs/development.md @@ -4,6 +4,11 @@ To develop and test changes to the-build, you'll generally need to have a Drupal 1. Choose a site to test against 2. Check out the-build as a git repository into the site's `vendor/` directory + - `cd vendor/palantirnet` + - `rm -rf the-build` + - `git clone git@github.com:palantirnet/the-build.git` + - `cd the-build` + - Checkout an existing branch or create a new one. 3. Make, commit, and push your changes from within `vendor/palantirnet/the-build/` The major thing to watch out for here is that your copy of the-build is temporary -- in certain cases (especially when switching branches) when you run composer commands, your repo may be replaced with a different version. From ee4cb81cf9b6d2ff27c07815e87cb514d1e7c671 Mon Sep 17 00:00:00 2001 From: Avi Schwab Date: Mon, 26 Nov 2018 14:32:29 -0600 Subject: [PATCH 4/5] Use --dev when using composer as the-build usually lives there --- docs/development.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/development.md b/docs/development.md index 67f9ce7b..d7c1ef9c 100644 --- a/docs/development.md +++ b/docs/development.md @@ -15,11 +15,11 @@ The major thing to watch out for here is that your copy of the-build is temporar ## Testing on an existing site -You can clone the-build into the vendor directory of an existing site. If it doesn't have a version of the-build already installed, you'll need to require it with `composer require palantirnet/the-build:dev-release-2.0` first. +You can clone the-build into the vendor directory of an existing site. If it doesn't have a version of the-build already installed, you'll need to require it with `composer require palantirnet/the-build:dev-release-2.0 --dev` first. ``` cd my-site -composer require palantirnet/the-build:dev-release-2.0 --prefer-source +composer require palantirnet/the-build:dev-release-2.0 --prefer-source --dev ``` At this point, `vendor/palantirnet/the-build` should be a clone of `git@github.com:palantirnet/the-build.git`. From 6870f6713305c2b0de0feaf94b74bcaaff13bfa2 Mon Sep 17 00:00:00 2001 From: Avi Schwab Date: Fri, 30 Nov 2018 13:52:22 -0600 Subject: [PATCH 5/5] Remove git and update composer instructions --- docs/development.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/development.md b/docs/development.md index d7c1ef9c..3d368577 100644 --- a/docs/development.md +++ b/docs/development.md @@ -4,18 +4,13 @@ To develop and test changes to the-build, you'll generally need to have a Drupal 1. Choose a site to test against 2. Check out the-build as a git repository into the site's `vendor/` directory - - `cd vendor/palantirnet` - - `rm -rf the-build` - - `git clone git@github.com:palantirnet/the-build.git` - - `cd the-build` - - Checkout an existing branch or create a new one. 3. Make, commit, and push your changes from within `vendor/palantirnet/the-build/` The major thing to watch out for here is that your copy of the-build is temporary -- in certain cases (especially when switching branches) when you run composer commands, your repo may be replaced with a different version. ## Testing on an existing site -You can clone the-build into the vendor directory of an existing site. If it doesn't have a version of the-build already installed, you'll need to require it with `composer require palantirnet/the-build:dev-release-2.0 --dev` first. +You can clone the-build into the vendor directory of an existing site. If it doesn't have a version of the-build already installed, you'll need to require it with `composer require palantirnet/the-build:dev-release-2.0 --prefer-source --dev` first. ``` cd my-site