cookbook 'magerun', '= 2.2.4'
magerun (7) Versions 2.2.4 Follow0
installs/configures n98-magerun.phar
cookbook 'magerun', '= 2.2.4', :supermarket
knife supermarket install magerun
knife supermarket download magerun
chef-magerun
chef-magerun installs n98-magerun and provides access to a corresponding LWRP.
Usage
Simply include the recipe in your application recipe, where you setup/deploy magento.
ruby
include_recipe "magerun"
ATTENTION: name this cookbook "magerun" if you want to use the LWRP like this:
ruby
magerun "PATH TO YOUR MAGENTO ROOT" do
action :cache_flush
end
See Command-Reference for available commands.
Keep an eye on the associated actions in the LWRP (providers/default.rb) since some commands had to be rewritten using no "-".
As a sidenote for vagrant users: - You may set up a bash function to use a pseudo-tty with magerun in the vagrant box.
e.g. in your local ~/.bash_profile
place:
bash
magerun () {
vagrant ssh -- -t n98-magerun.phar --root-dir=/vagrant $@
}
Open a new bash prompt at your Vagrant project and interact with n98-magerun as if it were local.
$ magerun help
$ magerun cache:clean
Your commands will be run inside the Vagrant box using the n98-magerun config and Magento root defined.
For performance reasons you might like to use the $ magerun shell
feature rather than opening a new ssh connection for each command.
Dependencies
This cookbook depends on the following community cookbooks.
- php
Recommendations
- dop_php
Platform
The following platforms are supported and tested:
- Debian 6.x
- Debian 7.x
- Ubuntu 14.04.x
Other Debian family distributions are assumed to work.
Development
- Fork the repository from GitHub.
-
Clone your fork to your local machine:
$ git clone git@github.com:USER/chef-magerun.git
-
Create a git branch
$ git checkout -b my_bug_fix
Write tests
Make your changes/patches/fixes, committing appropriately
Run the tests:
foodcritic
,rubocop
,kitchen test
Push your changes to GitHub
Open a Pull Request
Testing
chef-magerun is on Travis CI which tests against multiple Chef and Ruby versions.
The following Rake tasks are provided for automated testing of the cookbook:
-
rake rubocop
- Run [RuboCop] style and lint checks -
rake foodcritic
- Run [Foodcritic] lint checks -
rake integration
- Run [Test Kitchen] integration tests (provisions a Vagrant VM using this cookbook and then tests the infrastructure with [Serverspec]) -
rake test
- Run all tests
License and Author
Author:: Achim Rosenhagen (a.rosenhagen@ffuenf.de)
Copyright:: 2015, ffuenf
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
php >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
CHANGELOG for magerun
This file is used to list changes made in each version of magerun.
2.2.4:
- fix install command (path)
- use system-wide config
- add locations of compressed sample data
2.2.3:
- fix installation of n98-magerun modules
2.2.2:
- Allow for 15 minute timout on magerun executions (tatemz)
2.2.1:
- Sample data during installation is marked by default. Created an option to turn off sample data. (tatemz)
- Fixed find -exec bug. (tatemz)
- Added output and debugging options. (tatemz)
2.2.0:
- update/integrate testsuites: test-kitchen, foodcritic, rubocop, travis-ci
- prepare for release on supermarket.chef.io
2.1.3:
- update install command: check for required php extensions (fixes #1 / thx tatemz)
- add set_permissions action (fixes #2 / thx tatemz)
2.1.2:
- update install command
2.1.1:
- add overwrite config and set root user warning default to false
2.1.0:
- update/integrate testsuites: test-kitchen, foodcritic, rubocop, travis-ci
2.0.3:
- fix db:drop --force command
2.0.2:
- add role attribute to admin:user:create
2.0.1:
- add sys:setup:incremental command
2.0.0:
- remove composer entirely as its not needed here
- move installation of magerun from LWRP to default recipe
- fix commands
1.1.0:
- remove dependency to chef-php-extra by including own composer lwrp
- add new magerun commands (v1.85.0)
1.0.0:
- Initial release of magerun
Foodcritic Metric
2.2.4 passed this metric
2.2.4 passed this metric