Skip to content

Commit

Permalink
Merge branch 'composer-package' of https://github.com/acquia/blt into…
Browse files Browse the repository at this point in the history
… composer-package

* 'composer-package' of https://github.com/acquia/blt:
  Replace blt sh mentions with blt alias. (#263)
  • Loading branch information
grasmash committed Aug 7, 2016
2 parents 9da2a86 + a2b129c commit a465558
Show file tree
Hide file tree
Showing 13 changed files with 32 additions and 32 deletions.
6 changes: 3 additions & 3 deletions phing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ This directory should not contain any test files. Those exist in the [/tests](/t

A large number of common build tasks are provided via Phing targets. These include tasks for things like code sniffing, executing tests, building dependencies, installing Drupal, etc.

For a full list of available Phing tasks, run `./blt.sh -list` from the project's root directory.
For a full list of available Phing tasks, run `blt -list` from the project's root directory.

### Executing Tasks

* For a full list of the available Phing targets, run `./blt.sh -list`
* To manually test a Phing target, run the following command matching the the following pattern: `./blt.sh <target-name>`. For example `./blt.sh validate:all`
* For a full list of the available Phing targets, run `blt -list`
* To manually test a Phing target, run the following command matching the the following pattern: `blt <target-name>`. For example `blt validate:all`
* To run Phing directly from the binary, simply run `./bin/phing -f build/phing/build.xml <arguments>`

## <a name="ci"></a> Continuous Integration
Expand Down
2 changes: 1 addition & 1 deletion phing/example.multisite.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Values in this file may override default values set elsewhere. You can pass
# configuration from this file to Phing. E.g.,
# ./blt.sh tests:behat -propertyfile build/custom/phing/example.multisite.yml
# blt tests:behat -propertyfile build/custom/phing/example.multisite.yml

behat:
# @see http://docs.behat.org/en/v2.5/guides/6.cli.html#gherkin-filters
Expand Down
2 changes: 1 addition & 1 deletion phing/tasks/deploy.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<then>
<echo message="You must pass deploy.commitMsg and deploy.branch as runtime parameters."/>
<echo message="Command should match syntax:"/>
<echo message="./blt.sh deploy -Ddeploy.commitMsg='BLT-123: The commit message.' -Ddeploy.branch='master-build'"/>
<echo message="blt deploy -Ddeploy.commitMsg='BLT-123: The commit message.' -Ddeploy.branch='master-build'"/>
<fail message="Missing required parameters."/>
</then>
</if>
Expand Down
2 changes: 1 addition & 1 deletion phing/tasks/setup.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<target name="setup" description="Install dependencies, builds docroot, installs Drupal."
depends="setup:build, setup:drupal:install, install-alias">
<echo>For a full list of available Phing targets, run:</echo>
<echo>./blt.sh -l</echo>
<echo>blt -l</echo>
<echo></echo>
</target>

Expand Down
2 changes: 1 addition & 1 deletion scripts/tugboat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To set up this project with Tugboat, run the following commands from the project root:

```
./blt.sh ci:tugboat:init
blt ci:tugboat:init
```

## Workflow
Expand Down
4 changes: 2 additions & 2 deletions template/.travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ before_script:
- drupal yaml:update:value project.yml project.local.hostname '127.0.0.1:8888'

script:
- ./blt.sh -Dbehat.run-server=true -Dcreate_alias=false -Dbehat.launch-phantom=true ci:build:validate:test
- blt -Dbehat.run-server=true -Dcreate_alias=false -Dbehat.launch-phantom=true ci:build:validate:test

# Uncomment to enable automatic deployments following merges.
deploy:
# provider: script
# script: ./blt.sh deploy -Ddeploy.commitMsg="Automated commit by Travis CI for Build ${TRAVIS_BUILD_ID}" -Ddeploy.branch="${TRAVIS_BRANCH}-build"
# script: blt deploy -Ddeploy.commitMsg="Automated commit by Travis CI for Build ${TRAVIS_BUILD_ID}" -Ddeploy.branch="${TRAVIS_BRANCH}-build"
# skip_cleanup: true
# on:
# branch: master
2 changes: 1 addition & 1 deletion template/readme/acsf-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To configure a project to run on ACSF, perform the following steps after initially setting up BLT:

1. Add the following line to project.yml: `hosting: "acsf"`. This ensures that the correct settings files are added to the deployment artifact.
1. Execute `./blt.sh acsf:init` from the project root.
1. Execute `blt acsf:init` from the project root.
1. Ensure that `drupal/acsf` is a listed dependency in your composer.json file: `composer require drupal/acsf:~8`
1. Add the acsf module as a dependency to your installation profile

Expand Down
6 changes: 3 additions & 3 deletions template/readme/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Ensure your ACE remote is listed in project.yml under git:remotes.

In order to create the build artifact in `/deploy`, simply run
```
./blt.sh deploy:build
blt deploy:build
```

This task is analogous to `setup:build` but with a few critical differences:
Expand All @@ -38,7 +38,7 @@ After the artifact is created, you can inspect it or even run it as a website lo
To both create and deploy the build artifact in a single command, run the following command

````
./blt.sh deploy -Ddeploy.branch=develop-build -Ddeploy.commitMsg='BLT-123: The commit message.'
blt deploy -Ddeploy.branch=develop-build -Ddeploy.commitMsg='BLT-123: The commit message.'
````

This command will commit the artifact to the `develop-build` branch with the specified commit message and push it to the remotes defined in project.yml.
Expand All @@ -48,7 +48,7 @@ This command will commit the artifact to the `develop-build` branch with the spe
If you would like to create, commit, but _not push_ the artifact, you may do a dry run:

````
./blt.sh deploy -Ddeploy.branch=develop-build -Ddeploy.commitMsg='BLT-123: The commit message.' -Ddeploy.dryRun=true
blt deploy -Ddeploy.branch=develop-build -Ddeploy.commitMsg='BLT-123: The commit message.' -Ddeploy.dryRun=true
````

This is helpful for debugging deployment artifacts.
Expand Down
6 changes: 3 additions & 3 deletions template/readme/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ _BLT support for Drupal VM is experimental. Not all BLT features currently work

To use [Drupal VM](http://www.drupalvm.com/) with a Drupal project that is generated with BLT:

1. Execute `./blt.sh vm:init` from the project root directory.
1. Execute `blt vm:init` from the project root directory.
1. Follow the Quick Start Guide in [Drupal VM's README](https://github.com/geerlingguy/drupal-vm#quick-start-guide)

There are also other changes you can make if you choose to match the Acquia Cloud server configuration more closely. See Drupal VM's example configuration changes in Drupal VM's `examples/acquia/acquia.overrides.yml` file.
Expand All @@ -48,11 +48,11 @@ To execute Behat tests using the 'drupal' driver on a Drupal VM environment, you
1. SSH into the VM `vagrant ssh`.
1. Change to your project directory `cd /var/www/[project.machine_name]`.
1. Assert that PhantomJS is installed for VM: `composer run-script install-phantomjs`
1. Execute behat tests `./blt.sh tests:behat`
1. Execute behat tests `blt tests:behat`

#### Using the Drupal Extension's "drush" driver with Drupal VM

You may choose to write only behat tests that utilize the Drupal Extension's "drupal" driver. Doing this will allow you to run `./blt.sh tests:behat` from the host machine without modificaitons to the Behat local.yml configuration.
You may choose to write only behat tests that utilize the Drupal Extension's "drupal" driver. Doing this will allow you to run `blt tests:behat` from the host machine without modificaitons to the Behat local.yml configuration.

## <a name="dd"></a>Using Acquia Dev Desktop for BLT-generated projects

Expand Down
8 changes: 4 additions & 4 deletions template/readme/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,17 @@ If you need to make requests via a proxy server, please [configure git to use a

1. Checkout the `develop` branch. `git checkout develop`
1. Run `composer install` (you must already have Composer installed).
1. Run `./blt.sh setup:drupal:settings` This will generate
1. Run `blt setup:drupal:settings` This will generate
`docroot/sites/default/settings/local.settings.php` and
`docroot/sites/default/local.drushrc.php`. Update these with your local
database credentials and your local site URL.
1. Run `./blt.sh local:setup`. This will build all project dependencies and install
1. Run `blt local:setup`. This will build all project dependencies and install
drupal.
1. Create and edit your local drush alias file. Copy `drush/site-aliases/example.local.aliases.drushrc.php` to `drush/site-aliases/local.aliases.drushrc.php`. Edit the new alias file with your local path.

After this initial setup, you should only need to run `./blt.sh setup:build` when composer.json is updated, and `./blt.sh local:drupal:install` when you need to reinstall the site.
After this initial setup, you should only need to run `blt setup:build` when composer.json is updated, and `blt local:drupal:install` when you need to reinstall the site.

For a full list of available project tasks, run `./blt.sh -l`. See [Project Tasks](project-tasks.md) for more information.
For a full list of available project tasks, run `blt -l`. See [Project Tasks](project-tasks.md) for more information.

### Local Git Configuration

Expand Down
16 changes: 8 additions & 8 deletions template/readme/project-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@

Pre-requisites to installation:

1. Ensure that `docroot/sites/default/settings/local.settings.php` exists by executing `./blt.sh setup:drupal:settings`.
1. Ensure that `docroot/sites/default/settings/local.settings.php` exists by executing `blt setup:drupal:settings`.
1. Verify that correct local database credentials are set in `local.settings.php`.
1. Ensure that project dependencies have already been built via `./blt.sh setup:build`
1. Ensure that project dependencies have already been built via `blt setup:build`

To re-install Drupal, execute: `./blt.sh setup:drupal:install`. Note that this will drop the existing database tables and install Drupal from scratch!
To re-install Drupal, execute: `blt setup:drupal:install`. Note that this will drop the existing database tables and install Drupal from scratch!

## <a name="update-dependency"></a>Update dependencies (core, profile, module, theme, libraries)

Expand Down Expand Up @@ -65,7 +65,7 @@ Please see [tests/README.md](../tests/README.md) for information on running test
To execute PHP codesniffer and PHP lint against the project codebase, run:

```
./blt.sh validate:all
blt validate:all
```

## <a name="frontend"></a>Build front end assets
Expand Down Expand Up @@ -95,7 +95,7 @@ target-hooks:
This command will be executed when dependencies are built in a local or CI environment, and when a deployment artifact is generated. You may execute the command directly by calling the `frontend:build` target:

```
./blt.sh frontend:build
blt frontend:build
```

## <a name="local-tasks"></a>Updating you local environment
Expand All @@ -107,19 +107,19 @@ The project is configured to update the local environment with a local drush ali
This all in one command will make sure your local is in sync with the remote site.

```
./blt.sh local:refresh
blt local:refresh
```

### Sync: Copy the database from the remote site

```
./blt.sh local:sync
blt local:sync
```

### Update: Run update tasks locally

```
./blt.sh local:update
blt local:update
```

These tasks can be seen in `build/core/phing/tasks/local-sync.xml`. An additional script can be added at `/hooks/dev/post-db-copy/dev-mode.sh` which would run at the end of this task.
6 changes: 3 additions & 3 deletions template/tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ Before attempting to execute any tests, verify that composer dependencies are bu

Each testing type can be either executed directly, or via a corresponding Phing target. Phing will execute the tests with default values defined in your project's yaml configuration files (project.yml). Examples:

* `./blt.sh tests:all`
* `./blt.sh tests:behat`
* `./blt.sh tests:phpunit`
* `blt tests:all`
* `blt tests:behat`
* `blt tests:phpunit`

To execute the tests directly (without Phing) see the following examples:

Expand Down
2 changes: 1 addition & 1 deletion template/tests/behat/example.local.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# To generate a local.yml file using this the example template, execute:
# `./blt.sh setup:behat` from the project root.
# `blt setup:behat` from the project root.
imports:
- behat.yml

Expand Down

0 comments on commit a465558

Please sign in to comment.