Skip to content

Commit 7f71553

Browse files
author
Adam Ross
committed
Update to version v4.0.0
1 parent 5943136 commit 7f71553

File tree

3 files changed

+64
-11
lines changed

3 files changed

+64
-11
lines changed

CHANGELOG.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,49 @@
1-
## v4.0.0-pre (August 42, 2020)
1+
# CHANGELOG
22

3-
### Upgrade Instructions
3+
## v4.0.0 (October 11, 2017)
4+
5+
One of the big changes in this release is the removal/deprecation of the
6+
bin/start.sh script. For a longish explanation why please check out [Deprecate the start.sh script in favor of using the underlying tools #59](https://github.com/phase2/generator-outrigger-drupal/issues/59)
7+
8+
For more on the breaking changes associated with this release read on past the change list.
9+
10+
* Moved generated .outrigger.yml to outrigger.yml for improved visibility. (:environment)
11+
* Removed start.sh script and replaced with a deprecation message. (:environment)
12+
* Added more robust rig project scripts instead of start.sh script. (:environment)
13+
* Added [documentation to repo](https://github.com/phase2/generator-outrigger-drupal/blob/master/docs/COMMANDS.md) on generated outrigger scripts.
14+
* Fixed composer install or composer update process does not return failure if patches fail to apply.
15+
* Added Drush defaults such that using drush via the cli service will target the site.
16+
(This removes the requirement to always use the alias via the cli service. Use `drush @none` to avoid Drupal bootstrap.)
17+
* Added out-of-box configuration for Xdebug via the CLI. (Ready out of box with [PHPStorm configuration](http://docs.outrigger.sh/common-tasks/using-xdebug-with-outrigger/))
18+
* Added validation to domain prompt to disallow capital letters. (:environment)
19+
* Refactored all things CI or remote-host oriented to the new `cloud` sub-generator.
20+
* Added prompt to enter the remote CI host. (:cloud)
21+
* Removed outrigger integration as optional (Jenkins integration is optional via :cloud) (:environment)
22+
* Fixed generated grunt fetch-db task. (:environment)
23+
* Fixed cli build service to default to use BASH. (:environment)
24+
* Fixed --replay flag.
25+
* Fixed Unison compatibility for bin/docker.sh. (:environment)
26+
27+
### Technical Plumbing
28+
29+
* Upgraded generator-gadget to v1.2.0 ([Release Notes](https://github.com/phase2/generator-gadget/releases/tag/v1.2.0))
30+
31+
### Contributors
32+
33+
@grayside, @scottalan, @jhedstrom, @mike-potter, @febbraro, @tekante
34+
35+
### Breaking Changes
36+
37+
#### Code Changes
438

539
To continue using the --replay flag with projects generated before v4, please make the following changes to your `.yo-rc.json` file, hidden at the root of your git repo.
40+
641
* Replace `useEnv` with `useCloud`.
7-
* Add `cloudHost` key set to the URL of your Docker host. (`ci.p2devcloud.com` or `ci2.p2devcloud.com`)
42+
* Add `cloudHost` key set to the URL of your Docker host. (For example: `ci.p2devcloud.com`)
43+
44+
#### System Requirements
45+
46+
Upgrade rig CLI to at least version 1.3.2.
847

948
## v3.4.0 (July 18, 2017)
1049

@@ -419,7 +458,7 @@ The `bin/start.sh` script has got command-line options now, including:
419458
* Break Jenkins home into views by environment with primary for key shortcuts.
420459
* Add jenkins-test-fail job to check on Jenkins error handling.
421460
* Added deploy-local job for local testing of Jenkins
422-
* Added the colorization library from _devtools_vm past, began light use.
461+
* Added the colorization library from \_devtools_vm past, began light use.
423462
* Automated test coverage, 45 assertions and counting.
424463
* Generated documentation improvements
425464

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,36 @@
66
[![Travis CI status](https://travis-ci.org/phase2/generator-outrigger-drupal.png?branch=master)](https://travis-ci.org/phase2/generator-outrigger-drupal)
77
[![Greenkeeper badge](https://badges.greenkeeper.io/phase2/generator-outrigger-drupal.svg)](https://greenkeeper.io/)
88

9-
**This project is mostly generic, but has some remaining pieces related to Phase2-specific development environment hosting.**
9+
**The Outrigger Cloud sub-generator is still tied to Phase2's internal Docker hosting solution. The next version will be more open.**
1010

11-
This is an umbrella [Yeoman](http://yeoman.io/) generator that asks questions,
11+
This project helps create new Drupal projects fully outfitted with environment
12+
support, build processes, frontend tooling, and more. It operates as an umbrella [Yeoman](http://yeoman.io/) generator that asks questions,
1213
then passes the answers to multiple "child" generators that handle their own
13-
aspect of project scaffolding. As the name implies, this generator focuses on Outrigger practices, where some of the other generators in use are focused on broader industry best practices.
14+
aspect of project scaffolding. As the name implies, this generator focuses on
15+
Outrigger practices, where some of the other generators in use are focused on
16+
broader industry best practices.
1417

1518
## Installation & Usage
1619

17-
### Using Docker
20+
### Using Docker Image
21+
22+
```
23+
mkdir ~/PROJECT-NAME
24+
cd ~/PROJECT-NAME
25+
docker run -it --rm -v $PWD:/generated outrigger/generator
26+
```
27+
28+
For more options check out [outrigger/generator directly](https://github.com/phase2/outrigger-generator).
29+
30+
### Using Docker for Development
1831

1932
Docker-based usage is available as of v3.0.0. It is the recommended approach as
2033
updates tend to be less prone to complication.
2134

2235
```bash
2336
git clone [email protected]:phase2/generator-outrigger-drupal.git
2437
cd generator-outrigger-drupal
25-
git checkout v3.4.0
38+
git checkout v4.0.0
2639
docker-compose run --rm cli npm install
2740
mkdir ~/path/to/empty/directory
2841
YO_PROJECT_DIRECTORY=~/path/to/empty/directory docker-compose run --rm yo outrigger-drupal
@@ -159,7 +172,8 @@ If you liked the Docker-based environments, you can also use our Docker-based
159172
Jenkins instance to manage your central test environments, complete with default
160173
jobs so you can start continuous integration with zero further configuration.
161174

162-
This uses a sub-generator of generator-outrigger-drupal which can be separately executed as `yo outrigger-drupal:jenkins`.
175+
This uses a sub-generator of generator-outrigger-drupal which can be separately
176+
executed as `yo outrigger-drupal:cloud`.
163177

164178
### Feature Breakdown
165179

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "generator-outrigger-drupal",
3-
"version": "4.0.0-pre",
3+
"version": "4.0.0",
44
"description": "Yeoman Generator for Outrigger-based Drupal projects.",
55
"license": "MIT",
66
"main": "app/index.js",

0 commit comments

Comments
 (0)