diff --git a/.gitignore b/.gitignore index 9af656e58..db909315b 100644 --- a/.gitignore +++ b/.gitignore @@ -100,6 +100,6 @@ nbproject/* *.sql *.zip -# Some files should be excluded from bolt but not from the projects it +# Some files should be excluded from blt but not from the projects it # generates, so they must be specified here rather than in template/.gitignore. template/.idea/.name diff --git a/.travis.yml b/.travis.yml index f4598afcb..963b7e134 100644 --- a/.travis.yml +++ b/.travis.yml @@ -45,13 +45,13 @@ before_script: - git diff --exit-code script: - # Generate a new 'bolted' project. - - ./bolt.sh configure - - ./bolt.sh create - # Call targets in the new 'bolted' project. - - ../bolted8/bolt.sh build:validate:test -Dcreate_alias=false -Dbehat.run-server=true -Dbehat.launch-phantom=true + # Generate a new 'blted' project. + - ./blt.sh configure + - ./blt.sh create + # Call targets in the new 'blted' project. + - ../blted8/blt.sh build:validate:test -Dcreate_alias=false -Dbehat.run-server=true -Dbehat.launch-phantom=true # Deploy build artifact. - - ../bolted8/bolt.sh deploy:artifact -Ddeploy.commitMsg="Automated commit by Travis CI for Build ${TRAVIS_BUILD_ID}" -Ddeploy.branch="8.x-build" - # Validate and run 'bolt' phpunit tests. - - phpcs --standard=../bolted8/vendor/drupal/coder/coder_sniffer/Drupal/ruleset.xml tests + - ../blted8/blt.sh deploy:artifact -Ddeploy.commitMsg="Automated commit by Travis CI for Build ${TRAVIS_BUILD_ID}" -Ddeploy.branch="8.x-build" + # Validate and run 'blt' phpunit tests. + - phpcs --standard=../blted8/vendor/drupal/coder/coder_sniffer/Drupal/ruleset.xml tests - phpunit tests diff --git a/INSTALL.md b/INSTALL.md index 5565057e2..946e0144c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,11 +1,11 @@ -## Creating a new project with Bolt +## Creating a new project with BLT -The following high-level steps will be required to generate a new, fully functioning site using Bolt: +The following high-level steps will be required to generate a new, fully functioning site using BLT: 1. Ensure your native OS meets minimum requirements -1. Clone Bolt to your local machine +1. Clone BLT to your local machine 1. Generate and modify configuration files for your new project -1. Use Bolt’s “installer” to generate a new site +1. Use BLT’s “installer” to generate a new site 1. Setup a local *AMP stack 1. Build your new project’s dependencies and install locally @@ -20,15 +20,15 @@ You should be able to use the following tools on the command line of your native * [Windows](http://php.net/manual/en/install.windows.php) * [Linux](http://php.net/manual/en/install.unix.debian.php) -## Prepare Bolt installer +## Prepare BLT installer -* Clone Bolt to your local machine on your native OS: - `git clone https://github.com/acquia/bolt.git` -* From the Bolt repository’s root directory, run `composer install`. This will build the dependencies required for Bolt’s “installer”. +* Clone BLT to your local machine on your native OS: + `git clone https://github.com/acquia/blt.git` +* From the BLT repository’s root directory, run `composer install`. This will build the dependencies required for BLT’s “installer”. # Generate and modify configuration files -From the Bolt repository’s root directory, run `./bolt.sh configure`. This will create your project-specific configuration files. After running, the following files should exist in the Bolt root directory: +From the BLT repository’s root directory, run `./blt.sh configure`. This will create your project-specific configuration files. After running, the following files should exist in the BLT root directory: * project.yml * local.drushrc.php @@ -43,15 +43,15 @@ At this point, you likely have not configured your local *AMP stack for your new ## Create a new project -Bolt’s “installer” will do the following: -* Create new project directory (sibling of the Bolt repository) -* Copies Bolt template files to the new directory +BLT’s “installer” will do the following: +* Create new project directory (sibling of the BLT repository) +* Copies BLT template files to the new directory * Replaces tokens in copied files with project-specific strings * Removes installation artifacts -Run `./bolt.sh create` to do all the things! +Run `./blt.sh create` to do all the things! -Once it’s completed, __change directories to your new project directory. All subsequent steps will happen inside your new project. You have left the Bolt repository behind.__ +Once it’s completed, __change directories to your new project directory. All subsequent steps will happen inside your new project. You have left the BLT repository behind.__ ## Modifying project files @@ -65,12 +65,12 @@ Note that all of the steps from this point forward are the same steps that would ## Set up your \*AMP stack -Before building your project dependencies and installing Drupal, you must have a fully functional \*AMP stack on your local machine. Bolt intentionally does not provide this local development environment--that is outside of the scope of Bolt’s intended responsibilities. It does, however, make recommendations for which tools you should use to manage your stack. +Before building your project dependencies and installing Drupal, you must have a fully functional \*AMP stack on your local machine. BLT intentionally does not provide this local development environment--that is outside of the scope of BLT’s intended responsibilities. It does, however, make recommendations for which tools you should use to manage your stack. Please see [Local Development](template/readme/local-development.md) for more information on setting up your \*AMP stack: - * [Acquia Dev Desktop](template/readme/local-development.md#using-acquia-dev-desktop-for-bolt-generated-projects) - * [Drupal VM](template/readme/local-development.md#using-drupal-vm-for-bolt-generated-projects) - * [Other](https://github.com/acquia/bolt/blob/8.x/template/readme/local-development.md#alternative-local-development-environments) + * [Acquia Dev Desktop](template/readme/local-development.md#using-acquia-dev-desktop-for-blt-generated-projects) + * [Drupal VM](template/readme/local-development.md#using-drupal-vm-for-blt-generated-projects) + * [Other](https://github.com/acquia/blt/blob/8.x/template/readme/local-development.md#alternative-local-development-environments) When you have completed setting up your local \*AMP stack, double check that the following pieces of information are still correct: @@ -79,7 +79,7 @@ When you have completed setting up your local \*AMP stack, double check that the ## Build your project’s dependencies and install Drupal -Run the following command from the project root: `./bolt.sh setup`. This will do a lot of things for you, including: +Run the following command from the project root: `./blt.sh setup`. This will do a lot of things for you, including: * Building dependencies * Installing local git hooks @@ -88,7 +88,7 @@ Run the following command from the project root: `./bolt.sh setup`. This will do When this task is complete, you should have a fully functioning Drupal site on your local machine. You can login to the site by running `drush uli`. -Note that all common project tasks are executed through `bolt.sh` in your project’s root directory. This file simply passes arguments through to Phing, which manages all task automation. For a full list of available tasks, run `./bolt.sh -l`. +Note that all common project tasks are executed through `blt.sh` in your project’s root directory. This file simply passes arguments through to Phing, which manages all task automation. For a full list of available tasks, run `./blt.sh -l`. ## Next Steps diff --git a/README.md b/README.md index f3a1ff8ce..551222434 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Bolt +# BLT -[![Build Status](https://travis-ci.org/acquia/bolt.svg?branch=8.x)](https://travis-ci.org/acquia/bolt) +[![Build Status](https://travis-ci.org/acquia/blt.svg?branch=8.x)](https://travis-ci.org/acquia/blt) -Bolt is a tool that generates new Drupal projects using a standardized template derived from Acquia Professional Services' best practices. +BLT is a tool that generates new Drupal projects using a standardized template derived from Acquia Professional Services' best practices. ## License @@ -14,7 +14,7 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY ## Philosophy and Purpose -Bolt is designed to improve efficiency and collaboration across Drupal projects by providing a common set of tools and standardized structure. It was born out of the need to reduce re-work, project set up time, and developer onboarding time. +BLT is designed to improve efficiency and collaboration across Drupal projects by providing a common set of tools and standardized structure. It was born out of the need to reduce re-work, project set up time, and developer onboarding time. Its explicit goals are to: @@ -28,11 +28,11 @@ It scope is discretely defined. It is *not* intended to provide: * A local hosting environment * A replacement for good judgement (as with Drupal, it leaves you the freedom to make mistakes) -## Creating a new project with Bolt +## Creating a new project with BLT -It isn’t accurate to say that you can “install” Bolt. Rather, you can use Bolt to generate a new project. Within that project, you can then perform common project tasks like build dependencies, install Drupal, run tests, etc. +It isn’t accurate to say that you can “install” BLT. Rather, you can use BLT to generate a new project. Within that project, you can then perform common project tasks like build dependencies, install Drupal, run tests, etc. -Follow the instructions in [INSTALL.md](INSTALL.md) to generate a new project using Bolt. +Follow the instructions in [INSTALL.md](INSTALL.md) to generate a new project using BLT. ## Features @@ -46,7 +46,7 @@ Follow the instructions in [INSTALL.md](INSTALL.md) to generate a new project us * HipChat * [Testing Framework](template/tests). * Behat: default `local.yml` configuration, example tests, `FeatureContext.php` - * PHPUnit: default tests for ensuring proper functioning of Bolt provided components + * PHPUnit: default tests for ensuring proper functioning of BLT provided components * [Project tasks](template/readme/project-tasks.md) * Executing tests and validating code * Building dependencies @@ -56,15 +56,15 @@ Follow the instructions in [INSTALL.md](INSTALL.md) to generate a new project us * Travis CI * GitHub -## Keeping Bolt projects up-to-date +## Keeping BLT projects up-to-date -"How do I pull down upstream changes from Bolt to my Bolt-generated project?" +"How do I pull down upstream changes from BLT to my BLT-generated project?" This is a popular question, and it's difficult to answer. -Bolt is designed as a "starter kit" rather than a "distribution". It intentionally began with a "fork it and forget it" approach to updates. This is largely due to the fact that Bolt generated files are templates that are meant to be customized, and pulling in upstream updates would wipe out those customizations. +BLT is designed as a "starter kit" rather than a "distribution". It intentionally began with a "fork it and forget it" approach to updates. This is largely due to the fact that BLT generated files are templates that are meant to be customized, and pulling in upstream updates would wipe out those customizations. -That said, there are components of Bolt that could be treated as dependencies that receive upstream updates. Those components include: +That said, there are components of BLT that could be treated as dependencies that receive upstream updates. Those components include: * Project tasks * Scripts @@ -72,26 +72,26 @@ That said, there are components of Bolt that could be treated as dependencies th The ideal approach would be to split each of these into a separate, versioned projects that could be treated as formal composer.json dependencies, but we don't currently have the resources to maintain all of those projects. -As a stopgap, you can run the following command to pull in upstream updates to specific files and directories in your Bolt generated project: +As a stopgap, you can run the following command to pull in upstream updates to specific files and directories in your BLT generated project: -`./bolt.sh setup:bolt:update` +`./blt.sh setup:blt:update` After running, you can review changes via `git diff` and decide what should be committed. # License, support, and contribution -Bolt is provided as an open source tool in the hope that it will enabled developers to easily generate new Drupal projects that conform to Acquia Professional Services' best practices. +BLT is provided as an open source tool in the hope that it will enabled developers to easily generate new Drupal projects that conform to Acquia Professional Services' best practices. Please feel free to contribute to the project or file issues via the GitHub issue queue. When doing so, please keep the following points in mind: -* Bolt is distributed under the GPLv2 license; WITHOUT ANY WARRANTY. +* BLT is distributed under the GPLv2 license; WITHOUT ANY WARRANTY. * The project maintainers make no commitment to respond to support requests, feature requests, or pull requests. -* All contributions to Bolt will be reviewed for compliance with Drupal Coding +* All contributions to BLT will be reviewed for compliance with Drupal Coding Standards and best practices as defined by the project maintainer. -* Feature that are part of the [Road Map](https://github.com/acquia/bolt/wiki/Road-Map) +* Feature that are part of the [Road Map](https://github.com/acquia/blt/wiki/Road-Map) will be prioritized for inclusion. -Bolt work is currently being tracked in the [Bolt GitHub issue queue] -(https://github.com/acquia/bolt/issues) and organized via a -[Waffle.io Kanban Board](https://waffle.io/acquia/bolt). +BLT work is currently being tracked in the [BLT GitHub issue queue] +(https://github.com/acquia/blt/issues) and organized via a +[Waffle.io Kanban Board](https://waffle.io/acquia/blt). diff --git a/bolt.sh b/blt.sh similarity index 100% rename from bolt.sh rename to blt.sh diff --git a/build/README.md b/build/README.md index 1dc6d3667..3f8838a23 100644 --- a/build/README.md +++ b/build/README.md @@ -1,17 +1,17 @@ -# Bolt Build Process +# BLT Build Process -Given that Bolt generates child projects which must be tested, the CI flow is a little confusing. The CI configuration is detailed below. +Given that BLT generates child projects which must be tested, the CI flow is a little confusing. The CI configuration is detailed below. ## CI Flow -When a pull request is submitted a travis build is run against Bolt. This tests Bolt's ability to generate a new project. After a successful build, the new project will be deployed to Acquia Cloud and to a GitHub repository, where another child Travis build is subsequently executed. Here is the step-by-step breakdown: +When a pull request is submitted a travis build is run against BLT. This tests BLT's ability to generate a new project. After a successful build, the new project will be deployed to Acquia Cloud and to a GitHub repository, where another child Travis build is subsequently executed. Here is the step-by-step breakdown: -1. Bolt 7.x Pull Request is submitted -2. Travis Build *against Bolt* creates Bolted7 child project +1. BLT 7.x Pull Request is submitted +2. Travis Build *against BLT* creates BLTed7 child project * Tests are run to assert that project was created * Tests are run against the child project (install, behat, phpunit, etc.) -3. Upon success, Bolted7 child project is pushed to ACE bolted 7 subscription. +3. Upon success, BLTed7 child project is pushed to ACE blted 7 subscription. * Tests assert that deployment to remote(s) was successful -4. Travis Build *against Bolted7* begins. Sadly, failure of this build has no impact on the success of Bolt's builds. Status of child builds should be checked periodically to verify that Bolt is generating a working build process for child projects out of the box. +4. Travis Build *against BLTed7* begins. Sadly, failure of this build has no impact on the success of BLT's builds. Status of child builds should be checked periodically to verify that BLT is generating a working build process for child projects out of the box. -Likewise, this process occurs for pull requests submitted to Bolt 8.x with Bolted8 as a companion project. +Likewise, this process occurs for pull requests submitted to BLT 8.x with BLTed8 as a companion project. diff --git a/build/phing/build.xml b/build/phing/build.xml index 95ca195a0..4bf4f8bbf 100644 --- a/build/phing/build.xml +++ b/build/phing/build.xml @@ -1,32 +1,32 @@ - + - - - + + + - + - + - + - - + - - - - - - - + + + + + + + - + - - + + The following files have been generated: - ${bolt.root}/project.yml - ${bolt.root}/local.settings.php - ${bolt.root}/local.drushrc.php + ${blt.root}/project.yml + ${blt.root}/local.settings.php + ${blt.root}/local.drushrc.php - Modify these files and then run "./bolt.sh create" to generate a new project. + Modify these files and then run "./blt.sh create" to generate a new project. - + - Please run "./bolt.sh configure" before running "./bolt.sh create." + Please run "./blt.sh configure" before running "./blt.sh create." - + - + Build aborted by user. - + - + - - + + - - - + + + - - - + + + - - - - + + + + - + - + @@ -126,26 +126,26 @@ - - - - + + + + - + - New project was created in ${bolt.new.dir} + New project was created in ${blt.new.dir} Please change to the new project directory and run the setup task: - cd ${bolt.new.dir} - ./bolt.sh setup + cd ${blt.new.dir} + ./blt.sh setup - - + @@ -158,7 +158,7 @@ diff --git a/build/phing/build.yml b/build/phing/build.yml index a36aaf477..8f546aaed 100644 --- a/build/phing/build.yml +++ b/build/phing/build.yml @@ -1,2 +1,2 @@ -bolt: - new.dir: ${bolt.root}/../${project.machine_name} +blt: + new.dir: ${blt.root}/../${project.machine_name} diff --git a/composer.json b/composer.json index ae3abbbae..4dbe7471f 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { - "name": "acquia/bolt", - "description": "Bolt", + "name": "acquia/blt", + "description": "BLT", "license": "GPL-2.0", "require": { "phing/phing": "2.*", diff --git a/template/.travis.yml b/template/.travis.yml index 310f00f58..1e1495e9a 100644 --- a/template/.travis.yml +++ b/template/.travis.yml @@ -49,12 +49,12 @@ before_script: - git diff --exit-code script: - - ./bolt.sh -Dbehat.run-server=true -Dcreate_alias=false -Dbehat.launch-phantom=true build:validate:test + - ./blt.sh -Dbehat.run-server=true -Dcreate_alias=false -Dbehat.launch-phantom=true build:validate:test # Uncomment to enable automatic deployments following merges. deploy: # provider: script - # script: ./bolt.sh deploy:artifact -Ddeploy.commitMsg="Automated commit by Travis CI for Build ${TRAVIS_BUILD_ID}" -Ddeploy.branch="${TRAVIS_BRANCH}-build" + # script: ./blt.sh deploy:artifact -Ddeploy.commitMsg="Automated commit by Travis CI for Build ${TRAVIS_BUILD_ID}" -Ddeploy.branch="${TRAVIS_BRANCH}-build" # skip_cleanup: true # on: # branch: master diff --git a/template/bolt.sh b/template/blt.sh similarity index 100% rename from template/bolt.sh rename to template/blt.sh diff --git a/template/build/README.md b/template/build/README.md index e26a8c535..3ab2d7a1a 100644 --- a/template/build/README.md +++ b/template/build/README.md @@ -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 `./bolt.sh -list` from the project's root directory. +For a full list of available Phing tasks, run `./blt.sh -list` from the project's root directory. ### Executing Tasks -* For a full list of the available Phing targets, run `./bolt.sh -list` -* To manually test a Phing target, run the following command matching the the following pattern: `./bolt.sh `. For example `./bolt.sh validate:all` +* 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 `. For example `./blt.sh validate:all` * To run Phing directly from the binary, simply run `./bin/phing -f build/phing/build.xml ` ## Continuous Integration diff --git a/template/build/core/README.md b/template/build/core/README.md index 030875a49..7b2a2ed74 100644 --- a/template/build/core/README.md +++ b/template/build/core/README.md @@ -1,7 +1,7 @@ -This directory contains the core tasks that ship with Bolt. No files in this +This directory contains the core tasks that ship with BLT. No files in this directory should be customized. You may pull in upstream changes with: - ./bolt.sh setup:bolt:update + ./blt.sh setup:blt:update Please note that pulling in upstream changes in this way may break your project. In some cases, you will need to change aspects of your project configuration or diff --git a/template/build/core/phing/build.xml b/template/build/core/phing/build.xml index 068353f21..8b379d249 100644 --- a/template/build/core/phing/build.xml +++ b/template/build/core/phing/build.xml @@ -1,4 +1,4 @@ - + @@ -10,7 +10,7 @@ - You are running Bolt with xdebug enabled. This has a major impact on + You are running BLT with xdebug enabled. This has a major impact on runtime performance. @@ -56,7 +56,7 @@ diff --git a/template/build/core/phing/example.multisite.yml b/template/build/core/phing/example.multisite.yml index 8888b1d93..8b0bb045c 100644 --- a/template/build/core/phing/example.multisite.yml +++ b/template/build/core/phing/example.multisite.yml @@ -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., -# ./bolt.sh tests:behat -propertyfile build/custom/phing/example.multisite.yml +# ./blt.sh tests:behat -propertyfile build/custom/phing/example.multisite.yml behat: # @see http://docs.behat.org/en/v2.5/guides/6.cli.html#gherkin-filters diff --git a/template/build/core/phing/tasks/deploy.xml b/template/build/core/phing/tasks/deploy.xml index 562ca0669..8ee932792 100644 --- a/template/build/core/phing/tasks/deploy.xml +++ b/template/build/core/phing/tasks/deploy.xml @@ -11,7 +11,7 @@ - + diff --git a/template/build/core/phing/tasks/setup.xml b/template/build/core/phing/tasks/setup.xml index 4294de361..250e71391 100644 --- a/template/build/core/phing/tasks/setup.xml +++ b/template/build/core/phing/tasks/setup.xml @@ -1,9 +1,9 @@ + depends="setup:build:all, setup:drupal:install, setup:blt:alias"> For a full list of available Phing targets, run: - ./bolt.sh -l + ./blt.sh -l @@ -101,24 +101,24 @@ - + You may be prompted to trust GitHub's SSL certification and to enter your GitHub password. If you have two factor authentication enabled for GitHub, you must use an access token in lieu of a password. GitHub access tokens can be generated here: https://github.com/settings/tokens - + - - Bolt can automatically create a Bash alias to make it easier to run Bolt tasks. + + BLT can automatically create a Bash alias to make it easier to run BLT tasks. This alias may be created in .bash_profile or .bashrc depending on your system architecture. - + diff --git a/template/build/custom/phing/build.xml b/template/build/custom/phing/build.xml index d767d556d..9236d046c 100644 --- a/template/build/custom/phing/build.xml +++ b/template/build/custom/phing/build.xml @@ -1,9 +1,9 @@ - + - + @@ -14,9 +14,9 @@ - + - + diff --git a/template/docroot/sites/default/settings/sample-secrets.settings.php b/template/docroot/sites/default/settings/sample-secrets.settings.php index fbc6da0d9..d65568b20 100644 --- a/template/docroot/sites/default/settings/sample-secrets.settings.php +++ b/template/docroot/sites/default/settings/sample-secrets.settings.php @@ -21,7 +21,7 @@ * - ['db']['name'] is specific to a Drupal site in a specific environment. */ switch ($conf['acquia_hosting_site_info']['db']['name']) { - case 'bolted': + case 'blted': /* * Acquia Network Connector * diff --git a/template/project.yml b/template/project.yml index e24853056..9e9d1115e 100644 --- a/template/project.yml +++ b/template/project.yml @@ -1,10 +1,10 @@ project: # Everyone: This will determine the the directory name of the new repository. # Dev Desktop users: this should match your local site name. - machine_name: 'bolted8' + machine_name: 'blted8' # Used for enforcing correct git commit msg syntax. prefix: 'BLT' - human_name: 'Bolted 8' + human_name: 'BLTed 8' profile: name: 'lightning' # Please ensure contrib profiles are also in your composer.json file. @@ -20,7 +20,7 @@ git: default_branch: master remotes: # Defining git remotes allows builds deployed via CI. - - bolt8@svn-5223.devcloud.hosting.acquia.com:bolt8.git + - blt8@svn-5223.devcloud.hosting.acquia.com:blt8.git drush: aliases: diff --git a/template/readme/acsf-setup.md b/template/readme/acsf-setup.md index 352c7cfd5..aa09eba36 100644 --- a/template/readme/acsf-setup.md +++ b/template/readme/acsf-setup.md @@ -1,9 +1,9 @@ # ACSF Setup -To configure a project to run on ACSF, perform the following steps after initially setting up Bolt: +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 `./bolt.sh acsf:init` from the project root. +1. Execute `./blt.sh 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 diff --git a/template/readme/deploy.md b/template/readme/deploy.md index 3d0f65c27..fde2be823 100644 --- a/template/readme/deploy.md +++ b/template/readme/deploy.md @@ -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 ``` -./bolt.sh deploy:artifact:build +./blt.sh deploy:artifact:build ``` This task is analogous to `setup:build:all` but with a few critical differences: @@ -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 ```` -./bolt.sh deploy:artifact -Ddeploy.branch=develop-build -Ddeploy.commitMsg='BLT-123: The commit message.' +./blt.sh deploy:artifact -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. diff --git a/template/readme/local-development.md b/template/readme/local-development.md index 7ef9a8167..ef0dc11ce 100644 --- a/template/readme/local-development.md +++ b/template/readme/local-development.md @@ -23,9 +23,9 @@ If you must use Windows, we recommend that: * [cmder](http://cmder.net/) * [cygwin](https://www.cygwin.com/) -## Using Drupal VM for Bolt-generated projects +## Using Drupal VM for BLT-generated projects -To use Drupal VM with a Drupal project that is generated with Bolt, first place your downloaded copy of Drupal VM inside the generated Drupal project folder, and name the drupal-vm directory `box`. +To use Drupal VM with a Drupal project that is generated with BLT, first place your downloaded copy of Drupal VM inside the generated Drupal project folder, and name the drupal-vm directory `box`. To make sure Drush commands work correctly with Drupal VM, inside the new project's `build/custom/phing/build.yml` file, override the `docroot` used for Drush commands with the value: @@ -60,7 +60,7 @@ Then follow the Quick Start Guide in [Drupal VM's README](https://github.com/gee # Set drupal_site_name to the project's human-readable name. drupal_site_name: [project_human_name] - # If you build the makefile using Bolt's built-in Phing task (recommended), + # If you build the makefile using BLT's built-in Phing task (recommended), # set `build_makefile` to `false`. build_makefile: false @@ -70,7 +70,7 @@ Then follow the Quick Start Guide in [Drupal VM's README](https://github.com/gee # database. install_site: true - # To add support for XSL, which is used for some Bolt-supplied tests, add + # To add support for XSL, which is used for some BLT-supplied tests, add # `php5-xsl` to `extra_packages`. extra_packages: - unzip @@ -80,7 +80,7 @@ There are also other changes you can make if you choose to match the Acquia Clou Once you've made these changes and completed the steps in Drupal VM's Quick Start Guide, you may run `vagrant up` to bring up your local development environment, and then access the site via the configured `drupal_domain`. -## Using Acquia Dev Desktop for Bolt-generated projects +## Using Acquia Dev Desktop for BLT-generated projects ### Project creation and installation changes diff --git a/template/readme/onboarding.md b/template/readme/onboarding.md index 4a081ca71..eee55b6af 100644 --- a/template/readme/onboarding.md +++ b/template/readme/onboarding.md @@ -23,7 +23,7 @@ You should be able to use the following tools on the command line of your native ### Operating Systems -We highly recommend that you *do not use Windows* directly for development. Many development tools (e.g., drush, gulp, etc.) are not built or tested for Windows compatibility. Furthermore, most CI solutions (e.g., Travis CI, Drupal CI, etc.) do not permit testing on Windows OS. Similarly, Bolt cannot be fully tested on Windows and is unsupported on this platform. +We highly recommend that you *do not use Windows* directly for development. Many development tools (e.g., drush, gulp, etc.) are not built or tested for Windows compatibility. Furthermore, most CI solutions (e.g., Travis CI, Drupal CI, etc.) do not permit testing on Windows OS. Similarly, BLT cannot be fully tested on Windows and is unsupported on this platform. If you must use Windows, we recommend that: * You have administrator access to your machine @@ -31,7 +31,7 @@ If you must use Windows, we recommend that: * [Git Bash](https://git-for-windows.github.io/) * [cmder](http://cmder.net/) * [cygwin](https://www.cygwin.com/) -* Run Bolt inside of a Drupal-VM instance +* Run BLT inside of a Drupal-VM instance ### Networking considerations @@ -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 `./bolt.sh setup:drupal:settings` This will generate +1. Run `./blt.sh 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 `./bolt.sh setup`. This will build all project dependencies and install +1. Run `./blt.sh 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 `./bolt.sh setup:build:all` when composer.json is updated, and `./bolt.sh setup:drupal:install` when you need to reinstall the site. +After this initial setup, you should only need to run `./blt.sh setup:build:all` when composer.json is updated, and `./blt.sh setup:drupal:install` when you need to reinstall the site. -For a full list of available project tasks, run `./bolt.sh -l`. See [Project Tasks](project-tasks.md) for more information. +For a full list of available project tasks, run `./blt.sh -l`. See [Project Tasks](project-tasks.md) for more information. ### Local Git Configuration @@ -74,7 +74,7 @@ Ensure that your local email address correctly matches the email address for you ## Updating you local environment -The project is configured to update the local environment with a local drush alias and a remote alias as defined in `project.yml`. Given that these aliases match, those in `drush/site-aliases/`, you can update the site with Bolt. +The project is configured to update the local environment with a local drush alias and a remote alias as defined in `project.yml`. Given that these aliases match, those in `drush/site-aliases/`, you can update the site with BLT. [Local Development Tasks](project-tasks.md#local-tasks) diff --git a/template/readme/project-tasks.md b/template/readme/project-tasks.md index b8422691d..8dcd44c99 100644 --- a/template/readme/project-tasks.md +++ b/template/readme/project-tasks.md @@ -13,11 +13,11 @@ Pre-requisites to installation: -1. Ensure that `docroot/sites/default/settings/local.settings.php` exists by executing `./bolt.sh setup:drupal:settings`. +1. Ensure that `docroot/sites/default/settings/local.settings.php` exists by executing `./blt.sh 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 `./bolt.sh setup:build:all` +1. Ensure that project dependencies have already been built via `./blt.sh setup:build:all` -To re-install Drupal, execute: `./bolt.sh setup:drupal:install`. Note that this will drop the existing database tables and install Drupal from scratch! +To re-install Drupal, execute: `./blt.sh setup:drupal:install`. Note that this will drop the existing database tables and install Drupal from scratch! ## Update dependencies (core, profile, module, theme, libraries) @@ -62,13 +62,13 @@ Please see [Deploy](deploy.md) for a detailed description of how to deploy to Ac Please see [tests/README.md](../tests/README.md) for information on running tests. -To execute PHP codesniffer and PHP lint against the project codebase, run: `./bolt.sh validate:all` +To execute PHP codesniffer and PHP lint against the project codebase, run: `./blt.sh validate:all` ## Build front end assets Ideally, you will be using a theme that uses SASS/SCSS, a styleguide, and other tools that require compilation. Like dependencies, the compiled assets should not be directly committed to the project repository. Instead, they should be built during the creation of a production-ready build artifact. -Bolt only natively supports the [Acquia PS Thunder](https://github.com/acquia-pso/thunder) base theme. +BLT only natively supports the [Acquia PS Thunder](https://github.com/acquia-pso/thunder) base theme. To install Thunder's dependencies: @@ -81,20 +81,20 @@ To build Thunder's assets, execute: ## Updating you local environment -The project is configured to update the local environment with a local drush alias and a remote alias as defined in `project.yml`. Given that these aliases match, those in `drush/site-aliases/`, you can update the site with Bolt. Please see [drush/README.md](../drush/README.md) for details on how to create these aliases. +The project is configured to update the local environment with a local drush alias and a remote alias as defined in `project.yml`. Given that these aliases match, those in `drush/site-aliases/`, you can update the site with BLT. Please see [drush/README.md](../drush/README.md) for details on how to create these aliases. ### Refresh: Rebuild the codebase, copy the database, and run updates This all in one command will make sure your local is in sync with the remote site. -`./bolt.sh local:refresh` +`./blt.sh local:refresh` ### Sync: Copy the database from the remote site -`./bolt.sh local:sync` +`./blt.sh local:sync` ### Update: Run update tasks locally -`./bolt.sh local:update` +`./blt.sh 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. diff --git a/template/scripts/bolt/alias b/template/scripts/bolt/alias index ed3e68216..b9fdc5600 100644 --- a/template/scripts/bolt/alias +++ b/template/scripts/bolt/alias @@ -1,14 +1,14 @@ -function bolt() { +function blt() { if [ "`git rev-parse --show-cdup 2> /dev/null`" != "" ]; then GIT_ROOT=$(git rev-parse --show-cdup) else GIT_ROOT="." fi - if [ -f "$GIT_ROOT/bolt.sh" ]; then - $GIT_ROOT/bolt.sh "$@" + if [ -f "$GIT_ROOT/blt.sh" ]; then + $GIT_ROOT/blt.sh "$@" else - echo "You must run this command from within a Bolt-generated project repository." + echo "You must run this command from within a BLT-generated project repository." fi } diff --git a/template/scripts/bolt/install-alias.sh b/template/scripts/bolt/install-alias.sh index 62c5acbcf..2942ecb5b 100755 --- a/template/scripts/bolt/install-alias.sh +++ b/template/scripts/bolt/install-alias.sh @@ -11,15 +11,15 @@ elif [ -f "$HOME/.profile" ]; then fi if [ ! -z "$DETECTED_PROFILE" ]; then - if [ "`grep 'function bolt' $DETECTED_PROFILE`" ]; then - echo "Alias for bolt already exists in $DETECTED_PROFILE" + if [ "`grep 'function blt' $DETECTED_PROFILE`" ]; then + echo "Alias for blt already exists in $DETECTED_PROFILE" exit fi DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) cat $DIR/alias >> $DETECTED_PROFILE - echo "Added alias for bolt to $DETECTED_PROFILE" + echo "Added alias for blt to $DETECTED_PROFILE" echo "Restart your terminal session to use the new command." else - echo "Could not install bolt alias. No profile found. Tried ~/.zshrc, ~/.bashrc, ~/.bash_profile and ~/.profile." + echo "Could not install blt alias. No profile found. Tried ~/.zshrc, ~/.bashrc, ~/.bash_profile and ~/.profile." fi diff --git a/template/scripts/bolt/update-scaffold b/template/scripts/bolt/update-scaffold index 8710e2ad4..6726bd082 100755 --- a/template/scripts/bolt/update-scaffold +++ b/template/scripts/bolt/update-scaffold @@ -5,14 +5,14 @@ BOLT_BRANCH=8.x # Upstream directories to pull. These will be prefixed with "template/". BOLT_DIRS=( - "bolt.sh" + "blt.sh" "build/core" "drush.wrapper" "factory-hooks/post-settings-php/protect_env.php.example" "factory-hooks/pre-settings-php/includes.php.example" "hooks/samples" "hooks/templates" - "scripts/bolt" + "scripts/blt" "scripts/deploy" "scripts/drupal" "scripts/git-hooks/pre-commit" @@ -22,16 +22,16 @@ BOLT_DIRS=( # Move into repository root. cd $GIT_ROOT -echo "Copying down upstream changes to the Bolt template." +echo "Copying down upstream changes to the BLT template." # Iteratively pull down upstream directories. for i in "${BOLT_DIRS[@]}" do - svn export https://github.com/acquia/bolt/branches/$BOLT_BRANCH/template/$i $i --force + svn export https://github.com/acquia/blt/branches/$BOLT_BRANCH/template/$i $i --force done # Restore execute permissions. -chmod 755 bolt.sh +chmod 755 blt.sh chmod 755 drush.wrapper echo "Changes have been pulled down. Please review and commit desired changes." diff --git a/template/scripts/git-hooks/pre-commit b/template/scripts/git-hooks/pre-commit index 32c6c4237..5f2ad9943 100755 --- a/template/scripts/git-hooks/pre-commit +++ b/template/scripts/git-hooks/pre-commit @@ -13,5 +13,5 @@ if [ ! -f $PHPCS_BIN ]; fi -${ROOT_DIR}bolt.sh validate:phpcs:files -Dfiles="$LIST" -q +${ROOT_DIR}blt.sh validate:phpcs:files -Dfiles="$LIST" -q exit 0; diff --git a/template/tests/README.md b/template/tests/README.md index 3deb82faf..494130d7a 100644 --- a/template/tests/README.md +++ b/template/tests/README.md @@ -71,14 +71,14 @@ 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: -* `./bolt.sh tests:all` -* `./bolt.sh tests:behat` -* `./bolt.sh tests:phpunit` +* `./blt.sh tests:all` +* `./blt.sh tests:behat` +* `./blt.sh tests:phpunit` To execute the tests directly (without Phing) see the following examples: * `./vendor/bin/behat -c tests/behat/local.yml tests/behat/features/Examples.feature` -* `./vendor/bin/phpunit tests/phpunit/BoltTest.php` +* `./vendor/bin/phpunit tests/phpunit/BLTTest.php` For more information on the commands, run: diff --git a/template/tests/behat/example.local.yml b/template/tests/behat/example.local.yml index f79164a34..81df2dc84 100644 --- a/template/tests/behat/example.local.yml +++ b/template/tests/behat/example.local.yml @@ -1,5 +1,5 @@ # To generate a local.yml file using this the example template, execute: -# `./bolt.sh setup:behat` from the project root. +# `./blt.sh setup:behat` from the project root. imports: - behat.yml diff --git a/template/tests/phpunit/SettingsTest.php b/template/tests/phpunit/SettingsTest.php index dd448afcf..8ea583f23 100644 --- a/template/tests/phpunit/SettingsTest.php +++ b/template/tests/phpunit/SettingsTest.php @@ -17,7 +17,7 @@ class SettingsTest extends TestBase { public function setupParams($env) { $_ENV['AH_SITE_ENVIRONMENT'] = $env; - $_ENV['AH_SITE_NAME'] = $_ENV['AH_SITE_GROUP'] = 'bolt'; + $_ENV['AH_SITE_NAME'] = $_ENV['AH_SITE_GROUP'] = 'blt'; // @codingStandardsIgnoreStart $_SERVER['REMOTE_ADDR'] = '127.0.0.1'; // @codingStandardsIgnoreEnd diff --git a/tests/phpunit/BoltTest.php b/tests/phpunit/BltTest.php similarity index 89% rename from tests/phpunit/BoltTest.php rename to tests/phpunit/BltTest.php index 6c4131c3c..fbd6f5b9c 100644 --- a/tests/phpunit/BoltTest.php +++ b/tests/phpunit/BltTest.php @@ -5,12 +5,12 @@ use Symfony\Component\Yaml\Yaml; /** - * Class BoltTest. + * Class BLTTest. * - * Verifies that project structure and configuration matches Bolt + * Verifies that project structure and configuration matches BLT * standards. */ -class BoltTest extends \PHPUnit_Framework_TestCase { +class BltTest extends \PHPUnit_Framework_TestCase { /** * Class constructor. @@ -25,17 +25,17 @@ public function __construct() { /** * Tests Phing pt:create target. */ - public function testBoltCreate() { + public function testBltCreate() { $this->assertFileExists($this->new_project_dir); $this->assertFileNotExists($this->new_project_dir . '/install'); - $this->assertFileNotExists($this->new_project_dir . '/tests/phpunit/Bolt.php'); + $this->assertFileNotExists($this->new_project_dir . '/tests/phpunit/BltTest.php'); $this->assertFileExists($this->new_project_dir . '/vendor'); $this->assertNotContains( 'pt:self-test', file_get_contents($this->new_project_dir . '/.travis.yml') ); - $this->assertFileNotExists($this->new_project_dir . '/build/tasks/bolt.xml'); + $this->assertFileNotExists($this->new_project_dir . '/build/tasks/blt.xml'); $this->assertNotContains( '${project.machine_name}', file_get_contents($this->new_project_dir . '/docroot/sites/default/settings.php') diff --git a/tests/phpunit/DeployTest.php b/tests/phpunit/DeployTest.php index bf9390a4a..5eb2e4713 100644 --- a/tests/phpunit/DeployTest.php +++ b/tests/phpunit/DeployTest.php @@ -25,7 +25,7 @@ public function __construct() { /** * Tests Phing deploy:build:all target. */ - public function testBoltDeployBuild() { + public function testBltDeployBuild() { // Ensure deploy directory exists. $this->assertFileExists($this->deploy_dir); @@ -53,7 +53,7 @@ public function testBoltDeployBuild() { /** * Tests Phing deploy:build:push target. */ - public function testBoltDeployPush() { + public function testBltDeployPush() { global $_ENV; $deploy_branch = '8.x-build';