Skip to content

Commit

Permalink
Update to version v4.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam Ross committed Oct 12, 2017
1 parent 5943136 commit 7f71553
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 11 deletions.
47 changes: 43 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,49 @@
## v4.0.0-pre (August 42, 2020)
# CHANGELOG

### Upgrade Instructions
## v4.0.0 (October 11, 2017)

One of the big changes in this release is the removal/deprecation of the
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)

For more on the breaking changes associated with this release read on past the change list.

* Moved generated .outrigger.yml to outrigger.yml for improved visibility. (:environment)
* Removed start.sh script and replaced with a deprecation message. (:environment)
* Added more robust rig project scripts instead of start.sh script. (:environment)
* Added [documentation to repo](https://github.com/phase2/generator-outrigger-drupal/blob/master/docs/COMMANDS.md) on generated outrigger scripts.
* Fixed composer install or composer update process does not return failure if patches fail to apply.
* Added Drush defaults such that using drush via the cli service will target the site.
(This removes the requirement to always use the alias via the cli service. Use `drush @none` to avoid Drupal bootstrap.)
* 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/))
* Added validation to domain prompt to disallow capital letters. (:environment)
* Refactored all things CI or remote-host oriented to the new `cloud` sub-generator.
* Added prompt to enter the remote CI host. (:cloud)
* Removed outrigger integration as optional (Jenkins integration is optional via :cloud) (:environment)
* Fixed generated grunt fetch-db task. (:environment)
* Fixed cli build service to default to use BASH. (:environment)
* Fixed --replay flag.
* Fixed Unison compatibility for bin/docker.sh. (:environment)

### Technical Plumbing

* Upgraded generator-gadget to v1.2.0 ([Release Notes](https://github.com/phase2/generator-gadget/releases/tag/v1.2.0))

### Contributors

@grayside, @scottalan, @jhedstrom, @mike-potter, @febbraro, @tekante

### Breaking Changes

#### Code Changes

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.

* Replace `useEnv` with `useCloud`.
* Add `cloudHost` key set to the URL of your Docker host. (`ci.p2devcloud.com` or `ci2.p2devcloud.com`)
* Add `cloudHost` key set to the URL of your Docker host. (For example: `ci.p2devcloud.com`)

#### System Requirements

Upgrade rig CLI to at least version 1.3.2.

## v3.4.0 (July 18, 2017)

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

Expand Down
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,36 @@
[![Travis CI status](https://travis-ci.org/phase2/generator-outrigger-drupal.png?branch=master)](https://travis-ci.org/phase2/generator-outrigger-drupal)
[![Greenkeeper badge](https://badges.greenkeeper.io/phase2/generator-outrigger-drupal.svg)](https://greenkeeper.io/)

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

This is an umbrella [Yeoman](http://yeoman.io/) generator that asks questions,
This project helps create new Drupal projects fully outfitted with environment
support, build processes, frontend tooling, and more. It operates as an umbrella [Yeoman](http://yeoman.io/) generator that asks questions,
then passes the answers to multiple "child" generators that handle their own
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.
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.

## Installation & Usage

### Using Docker
### Using Docker Image

```
mkdir ~/PROJECT-NAME
cd ~/PROJECT-NAME
docker run -it --rm -v $PWD:/generated outrigger/generator
```

For more options check out [outrigger/generator directly](https://github.com/phase2/outrigger-generator).

### Using Docker for Development

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

```bash
git clone git@github.com:phase2/generator-outrigger-drupal.git
cd generator-outrigger-drupal
git checkout v3.4.0
git checkout v4.0.0
docker-compose run --rm cli npm install
mkdir ~/path/to/empty/directory
YO_PROJECT_DIRECTORY=~/path/to/empty/directory docker-compose run --rm yo outrigger-drupal
Expand Down Expand Up @@ -159,7 +172,8 @@ If you liked the Docker-based environments, you can also use our Docker-based
Jenkins instance to manage your central test environments, complete with default
jobs so you can start continuous integration with zero further configuration.

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

### Feature Breakdown

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generator-outrigger-drupal",
"version": "4.0.0-pre",
"version": "4.0.0",
"description": "Yeoman Generator for Outrigger-based Drupal projects.",
"license": "MIT",
"main": "app/index.js",
Expand Down

0 comments on commit 7f71553

Please sign in to comment.