|
| 1 | + |
| 2 | + |
| 3 | +# Dkdeploy::Typo3::Cms |
| 4 | + |
| 5 | +[](https://travis-ci.org/repositories/dkdeploy/dkdeploy-typo3-cms) |
| 6 | +[](https://badge.fury.io/rb/dkdeploy-typo3-cms) [](http://inch-ci.org/github/dkdeploy/dkdeploy-typo3-cms) |
| 7 | + |
| 8 | +## Description |
| 9 | + |
| 10 | +dkdeploy-typo3-cms ruby gem represents the extension of [Capistrano](http://capistranorb.com/) tasks directed to the advanced deployment process. |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +Add this line to your application's `Gemfile` |
| 15 | + |
| 16 | + gem 'dkdeploy-typo3-cms', '~> 7.0' |
| 17 | + |
| 18 | +and then execute |
| 19 | + |
| 20 | + bundle install |
| 21 | + |
| 22 | +or install it yourself as |
| 23 | + |
| 24 | + gem install dkdeploy-typo3-cms |
| 25 | + |
| 26 | +## Usage |
| 27 | + |
| 28 | +Run in your project root |
| 29 | + |
| 30 | + cap install STAGES='dev,integration,testing,production' |
| 31 | + |
| 32 | +This command will create the following Capistrano file structure with all the standard pre-configured constants. |
| 33 | +Please be aware of the difference to the [native installation](http://capistranorb.com/documentation/getting-started/preparing-your-application/) of Capistrano. |
| 34 | +Certainly you have to adjust `config/deploy.rb` and respective stages and customize them for your needs. |
| 35 | + |
| 36 | +<pre> |
| 37 | + ├── Capfile |
| 38 | + └── config |
| 39 | + ├── deploy |
| 40 | + │ ├── dev.rb |
| 41 | + │ ├── integration.rb |
| 42 | + │ ├── testing.rb |
| 43 | + │ └── production.rb |
| 44 | + └── deploy.rb |
| 45 | +</pre> |
| 46 | + |
| 47 | +As next you have to append the following line to the `Capfile` in order to make use of dkdeploy extensions in addition to the standard Capistrano tasks: |
| 48 | + |
| 49 | + require 'capistrano/dkdeploy/typo3-cms' |
| 50 | + |
| 51 | +To convince yourself, that Capistrano tasks list has benn extended, please run |
| 52 | + |
| 53 | + cap -vT |
| 54 | + |
| 55 | +Please note, that dkdeploy uses the local copy strategy and overwrites the `:scm` constant. If you want to use it, |
| 56 | +you should do nothing more. However if you want to change it for example to `:git`, please add the following line to `deploy.rb` |
| 57 | + |
| 58 | + set :scm, :git |
| 59 | + |
| 60 | +For more information about available Capistrano constants please use the [Capistrano documentation](http://capistranorb.com/documentation/getting-started/preparing-your-application/). |
| 61 | +The complete list of the dkdeploy constants you find in `/lib/capistrano/dkdeploy` in # TODO: set link |
| 62 | + |
| 63 | +## Testing |
| 64 | + |
| 65 | +### Prerequisite |
| 66 | + |
| 67 | +Add the virtual box alias to your `hosts` file |
| 68 | + |
| 69 | + 192.168.156.183 dkdeploy-typo3-cms.dev |
| 70 | + |
| 71 | +### Running tests |
| 72 | + |
| 73 | +1. Start the local box (`vagrant up --provision`) |
| 74 | +2. Check coding styles (`rubocop`) |
| 75 | +3. Run BDD cucumber tests (`cucumber`) |
| 76 | + |
| 77 | +## Contributing |
| 78 | + |
| 79 | +1. Install [git flow](https://github.com/nvie/gitflow) |
| 80 | +2. Install [Homebrew](http://brew.sh/) and run `brew install mysql-connector-c` |
| 81 | +3. If project is not checked out already do git clone `git@github.com:dkdeploy/dkdeploy-typo3-cms.git` |
| 82 | +4. Checkout origin develop branch (`git checkout --track -b develop origin/develop`) |
| 83 | +5. Git flow initialize `git flow init -d` |
| 84 | +6. Installing gems `bundle install` |
| 85 | +7. Create new feature branch (`git flow feature start my-new-feature`) |
| 86 | +8. Run tests (README.md Testing) |
| 87 | +9. Commit your changes (`git commit -am 'Add some feature'`) |
0 commit comments