Merge branch 'release/3.0.0-beta.3'

factorial-io · Jan 26, 2019 · 2609fbb · 2609fbb
2 parents 9a63331 + e4a4f9e
commit 2609fbb
Show file tree

Hide file tree

Showing 15 changed files with 552 additions and 67 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -1,13 +1,27 @@
 # Changelog
 
+## 3.0.0-beta.3 / 2019-01-26
+
+### New
+
+  * Add transform to questions, update documentation, fix tests
+  * Refactor questions in `app:scaffold` questions are now part of the scaffold.yml
+  * Add support for copying a .netrc file to the docker container
+  * New command `jira`which will show all open tickets for the given project and user. (#22)
+
 ## 3.0.0-beta.2 / 2019-01-19
 
+### New
+
   * Add support for .fabfile.local.yaml in user-folder
+  * Show a message when a new version of phabalicious is available.
+
+### Fixed
+
   * Documentation for the new jira-command (#22)
   * Remove trailing semicolon (Fixes #23)
   * Report a proper error message when handling modules_enabled.txt or modules_disabled.txt is failing
   * Fix shell-completion
-  * Show a message when a new version of phabalicious is available.
 
 ## 3.0.0-beta.1 / 2019-01-10
 

diff --git a/composer.json b/composer.json
@@ -23,7 +23,8 @@
         "twig/twig": "^2.5",
         "ext-openssl": "*",
         "jakeasmith/http_build_url": "^1.0",
-        "padraic/phar-updater": "^1.0"
+        "padraic/phar-updater": "^1.0",
+        "lesstif/php-jira-rest-client": "^1.35"
     },
     "require-dev": {
         "symfony/phpunit-bridge": "^2.8|^3|^4.1",

diff --git a/composer.lock b/composer.lock
diff --git a/docs/docs/app-scaffold.md b/docs/docs/app-scaffold.md
@@ -5,6 +5,15 @@ Phabalicious has a simple but powerful scaffold-command. It will read a yml-file
 Here's an example of a scaffold-file:
 
 ```yaml
+questions:
+  name:
+    question: "The Name of this project"
+  shortName:
+    question: "The short-name of this project"
+    validation: "/^[A-Za-z0-9]{3,5}$/"
+    error: "The shortname may consist of 3 to 5 letters (A-Z) or digits (0-9)"
+    transform: lowercase
+
 variables:
   composerProject: drupal-composer/drupal-project:8.x-dev
   webRoot: web
@@ -31,7 +40,30 @@ scaffold:
   - cd %rootFolder%; git commit -m "Initial commit by phabalicious"
 ```
 
-The fabfile needs at least the `scaffold`-section. The `scaffold`-section is a list of commands, executed by phabalicious one by one. It will use the pattern-replacement known for scripts.
+The fabfile needs at least the `questions`and the `scaffold`-section. The `scaffold`-section is a list of commands, executed by phabalicious one by one. It will use the pattern-replacement known for scripts.
+
+## The `questions`-section
+
+This section contains a list of questions to be asked when running the scaffold-command. The yaml-key will get the value inputted by the user and can be used as a replacement pattern or in twig-templates. Answers can be validated against a regex and/or transformed to lower- or uppercase.
+
+An example:
+
+```
+questions:
+  <key>: 
+    question: <the text to display>
+    validation: <the regex to check the input against to>
+    error: <the error message to display, when validation fails>
+    transform: <lowercase|uppercase>
+```
+
+For non-interactive usage you can pass the values via commandline-options, where the option-name is the same as the key, for the above example: 
+
+|command-line option|Question key|
+|------|------|
+| --\<key\> | \<key\> |
+| --name | name |
+| --short-name | shortName |
 
 ## The `scaffold`-section
 Phabalicious will provide the following replacement-patterns out of the box: