joomla/weblinks
30
1
Fork 0
mirror of https://github.com/joomla-extensions/weblinks.git synced 2024-06-03 06:50:49 +00:00
Code Issues Releases Activity

Update documentation

Browse Source 
Add documentation about RoboFile.ini local configuration file
This commit is contained in:
Francesco Abeni 2015-10-29 16:54:04 +01:00
parent 6562fd304a
commit 6f115b1221
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -5,6 +5,21 @@ This repo is meant to hold the decoupled com_weblinks component and related code
# Tests # Tests
To prepare the system tests (Selenium) to be run in your local machine you are asked to rename the file `tests/acceptance.suite.dist.yml` to `tests/acceptance.suite.yml`. Afterwards, please edit the file according to your system needs. To prepare the system tests (Selenium) to be run in your local machine you are asked to rename the file `tests/acceptance.suite.dist.yml` to `tests/acceptance.suite.yml`. Afterwards, please edit the file according to your system needs.
## Optional: extra configuration for RoboFile
This is not required, and if in doubt you can just skip this section, but there may be some specific use cases when you need (or want) to override the default behaviour of RoboFile.php. To do this, copy `RoboFile.dist.ini` to `RoboFile.ini` and add options in INI format, one per line, e.g.
skipClone = true
cmsPath = tests/joomla-cms3
The currently available options are as follows:
* `skipClone`: set to `true` to avoid the cms repo being deleted and re-cloned at each test execution. Useful to save time and bandwidth while you're debugging your test environment. But please be aware that if you don't refresh the repo you'll have to manually check the `installation` folder is present and the `configuration.php` is not.
* `cmsPath`: set to the local path (absolute or relative) where you'd like the test website to be installed. Default is `tests/joomla-cms3`.
* `branch`: set to whatever existing branch from the `joomla-cms` project if you want to clone that specific branch. Default is `staging`.
## Run the tests
To run the tests please execute the following commands (for the moment only working in Linux and MacOS, for more information see: https://docs.joomla.org/Testing_Joomla_Extensions_with_Codeception): To run the tests please execute the following commands (for the moment only working in Linux and MacOS, for more information see: https://docs.joomla.org/Testing_Joomla_Extensions_with_Codeception):
```bash ```bash
@ -13,7 +28,6 @@ $ vendor/bin/robo
$ vendor/bin/robo run:tests $ vendor/bin/robo run:tests
``` ```
##For Windows: ##For Windows:
You need to install: You need to install:

2
RoboFile.dist.ini
View File

@ -1,8 +1,10 @@
; If set to true, the repo will not be cloned from GitHub and the local copy will be reused. ; If set to true, the repo will not be cloned from GitHub and the local copy will be reused.
; This setting will be obsolete once we have local Git cache enabled ; This setting will be obsolete once we have local Git cache enabled
skipClone = false skipClone = false
; If you want to setup your test website in a different folder, you can do that here. ; If you want to setup your test website in a different folder, you can do that here.
; You can also set an absolute path, i.e. /path/to/my/cms/folder ; You can also set an absolute path, i.e. /path/to/my/cms/folder
cmsPath = tests/joomla-cms3 cmsPath = tests/joomla-cms3
; If you want to clone a different branch, you can set it here ; If you want to clone a different branch, you can set it here
branch = staging branch = staging