-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0c1a4a4
commit 6d1f7ba
Showing
1 changed file
with
43 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,6 @@ Robo task to push git artefact to remote repository | |
| [](https://packagist.org/packages/integratedexperts/robo-git-artefact) | ||
| [](https://packagist.org/packages/integratedexperts/robo-git-artefact) | ||
|
|
||
|
|
||
| ## How it works | ||
| Say, you have 2 git repositories: _source_ and _destination_. | ||
|
|
||
|
|
@@ -20,17 +19,6 @@ By default, the _destination_ branch name follows the format `[branch]-[timestam | |
|
|
||
| Each _deployment branch_ will have all _source_ commits plus an extra _deployment commit_ with a _deployment message_. This commit is added even if there were no files added during the artefact build process (see below). By default, the _deployment commit message_ is `Deployment commit`, but it can be overridden by providing a `--message` option. Token replacement is supported (see below). | ||
|
|
||
| ### Adding dependencies | ||
| `--gitignore` option allows to specify the path to the _artefact gitignore_ file that replaces existing _.gitignore_ (if any) during the build. Any files no longer ignored by the replaced `artefact gitignore` are added in `deployment commit`. If there are no no-longer-excluded files, the _deployment commit_ is still created, to make sure that the deployment timestamp is captured. | ||
|
|
||
| ### Token support | ||
| Both `--branch` and `--message` option values support token replacement. Tokens are pre-defined strings surrounded by `[` and `]` and may contain optional formatter (for flexibility). For example, `[timestamp:Y-m-d]` is replaced with current timestamp in format `Y-m-d` (token formatter), which is PHP `date()` expected format. | ||
|
|
||
| Available tokens: | ||
| - `[timestamp:FORMAT]` - current time with a PHP `date()`-compatible format. | ||
| - `[branch]` - current `source` branch. | ||
| - `[tags]` - tags from latest `_source` commit (if any), separated by comma. | ||
|
|
||
| ## Usage | ||
|
|
||
| In your `RoboFile.php`: | ||
|
|
@@ -57,3 +45,46 @@ class RoboFile extends \Robo\Tasks | |
|
|
||
| ### Run | ||
| `robo artefact [email protected]/repository.git` - this will create an artefact from current directory and will send it to the specified remote repository into the same branch as a current one. | ||
|
|
||
| # Options | ||
| ``` | ||
| Usage: | ||
| artefact [options] [--] <remote> | ||
| Arguments: | ||
| remote Path to the remote git repository. | ||
| Options: | ||
| --root=ROOT Path to the root for file path resolution. If not specified, current directory is used. | ||
| --src=SRC Directory where source repository is located. If not specified, root directory is used. | ||
| --branch=BRANCH Destination branch with optional tokens. | ||
| --message=MESSAGE Commit message with optional tokens. | ||
| --gitignore=GITIGNORE Path to gitignore file to replace current .gitignore. | ||
| --push Push artefact to the remote repository. Defaults to FALSE. | ||
| --now=NOW | ||
| -h, --help Display this help message | ||
| -q, --quiet Do not output any message | ||
| -V, --version Display this application version | ||
| --ansi Force ANSI output | ||
| --no-ansi Disable ANSI output | ||
| -n, --no-interaction Do not ask any interactive question | ||
| --simulate Run in simulated mode (show what would have happened). | ||
| --progress-delay=PROGRESS-DELAY Number of seconds before progress bar is displayed in long-running task collections. Default: 2s. [default: 2] | ||
| -D, --define=DEFINE Define a configuration item value. (multiple values allowed) | ||
| -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug | ||
| Help: | ||
| Push artefact of current repository to remote git repository. | ||
| ``` | ||
|
|
||
| ### Adding dependencies | ||
| `--gitignore` option allows to specify the path to the _artefact gitignore_ file that replaces existing _.gitignore_ (if any) during the build. Any files no longer ignored by the replaced _artefact gitignore_ are added into the _deployment commit_. If there are no no-longer-excluded files, the _deployment commit_ is still created, to make sure that the deployment timestamp is captured. | ||
|
|
||
| ### Token support | ||
| Both `--branch` and `--message` option values support token replacement. Tokens are pre-defined strings surrounded by `[` and `]` and may contain optional formatter (for flexibility). For example, `[timestamp:Y-m-d]` is replaced with current timestamp in format `Y-m-d` (token formatter), which is PHP `date()` expected format. | ||
|
|
||
| Available tokens: | ||
| - `[timestamp:FORMAT]` - current time with a PHP `date()`-compatible format. | ||
| - `[branch]` - current `source` branch. | ||
| - `[tags]` - tags from latest `_source` commit (if any), separated by comma. | ||
|
|
||