-
Notifications
You must be signed in to change notification settings - Fork 3
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
Showing
30 changed files
with
1,289 additions
and
251 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 |
|---|---|---|
|
|
@@ -13,5 +13,6 @@ | |
| /bin/phpunit | ||
| /build/phabalicious.phar | ||
| /docs/site | ||
| /tests/tmp | ||
| node_modules | ||
| docs/.vuepress/dist | ||
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
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
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| # Deploying artifacts | ||
|
|
||
| If you want to deploy artifacts, phabalicious can help you here, currently there are two methods supported: | ||
|
|
||
| * artifacts--git | ||
| * artifacts--ftp | ||
|
|
||
| Both methods create a new application from scratch and deploy all or parts of it to a ftp server or store the artifacts in a git repository. Both methods are using the same stage mechanisms as in `app:create`. | ||
|
|
||
| Both methods needs the global `repository`-config, so they can pull the app into a new temporary folder. | ||
|
|
||
| ## artifacts--ftp | ||
|
|
||
| ftp will create a new application in a temporary folder, install all needed dependencies, copies the data into a new temporary folder and run the deploy script of the host-config. After that is finished, phab will mirror all changed files via `lftp` to the server. `lftp` supports multiple protocols, not only ftp, but it needs to be installed on the machine running phab. | ||
|
|
||
| ftp-sync use the following stages: | ||
|
|
||
| * `installCode` will most of the time clone the source repository | ||
| * `installDependencies` will install all needed dependencies | ||
| * `runActions` will run all defined actions (see below) | ||
| * `runDeployScript` run the deploy-script of the host to apply some custom changes | ||
| * `syncToFtp` sync all changed files with the remote ftp server. | ||
|
|
||
| ### Example config | ||
|
|
||
| ```yaml | ||
|
|
||
| hosts: | ||
| ftp-artifacts: | ||
| needs: | ||
| - git | ||
| - composer | ||
| - artifacts--ftp | ||
| - script | ||
| artifact: | ||
| user: stephan | ||
| host: sftp://localhost | ||
| port: 22 | ||
| password: my-secret | ||
| rootFolder: /home/stephan/somewhere | ||
| actions: | ||
| - action: copy | ||
| arguments: | ||
| from: "*" | ||
| to: . | ||
| - action: script | ||
| arguments: | ||
| - cp .env.example .env | ||
| - action: delete | ||
| arguments: | ||
| - .git/ | ||
| - .fabfile | ||
| - .editorconfig | ||
| - .env.example | ||
| - .gitattributes | ||
| - .gitignore | ||
| - composer.lock | ||
| - composer.json | ||
| - docker-compose.yml | ||
| - action: script | ||
| arguments: | ||
| - ls -la | ||
| - action: confirm | ||
| arguments: | ||
| question: Do you want to continue? | ||
|
|
||
| ``` | ||
|
|
||
| The default actions for the ftp-artifact-method will copy all files to the target repo and remove the `.git`-folder and the fabfile. | ||
|
|
||
| ## artifacts--git | ||
|
|
||
| This method will create the artifact, pull the target repository, copy all necessary files over to the target repository, commit any changes to the target repository and push the changes again. A CI listening to commits can do the actual deployment | ||
|
|
||
| It is using the following stages: | ||
|
|
||
| * `installCode`, creates a temporary folder and pulls the source repository. (only when `useLocalRepository` is set to false) | ||
| * `installDependencies` to install the dependencies | ||
| * `getSourceCommitInfo` get the commit hash from the source repo. | ||
| * `runActions` will run all defined actions (see below) | ||
| * `copyFilesToTargetDirectory`, copy specified `files` to the target directory, removes all files listed in `excludeFiles.gitSync` | ||
| * `runDeployScript` run the deploy script of the host-config. | ||
| * `pushToTargetRepository` commit and push all changes, using the changelog as a commit-message | ||
|
|
||
| If you run phabalicious as part of a CI-setup, it might make sense to set `useLocalRepository` to true, as this will instruct phab to use the current folder as a base for the artifact and won't create a new application in another temporary folder. | ||
|
|
||
| ### Example config | ||
|
|
||
| ```yaml | ||
| hosts: | ||
| git-artifact: | ||
| needs: | ||
| - git | ||
| - composer | ||
| - artifacts--git | ||
| - script | ||
| artifact: | ||
| branch: master | ||
| repository: ssh://somewhere/repository.git | ||
| useLocalRepository: false | ||
| actions: | ||
| - action: copy | ||
| arguments: | ||
| from: '*' | ||
| to: . | ||
| - action: script | ||
| arguments: | ||
| - cp .env.example .env | ||
| - action: delete | ||
| arguments: | ||
| - .env.example | ||
| - composer.json | ||
| - composer.lock | ||
| - docker-compose.yml | ||
| - docker-compose-mbb.yml | ||
| - .projectCreated | ||
| ``` | ||
| the default actions for the git-artifact-method will copy all files to the target repo and remove the fabfile. | ||
| ## Available actions | ||
| You can customize the list of actions be run when deploying an artifact. Here's a list of available actions | ||
| ### copy | ||
| ```yaml | ||
| - action: copy | ||
| argumnents: | ||
| from: | ||
| - file1 | ||
| - folder2 | ||
| - subfolder/file3 | ||
| to: targetsubfolder | ||
| ``` | ||
| This will copy the three mentioned files and folders into the subfolder `targetsubfolder` of the target folder. Please be aware, that you might need to create subdirectories beforehand manually via the `script`-method | ||
|
|
||
| ### delete | ||
|
|
||
| ```yaml | ||
| - action: delete | ||
| arguments: | ||
| - file1 | ||
| - folder2 | ||
| - subfolder/file3 | ||
| ``` | ||
|
|
||
| This action will delete the list of files and folders in the target folder. Here you can clean up the target and get rid of unneeded files. | ||
|
|
||
| ### exclude | ||
|
|
||
| ```yaml | ||
| - action: exclude | ||
| arguments: | ||
| - file1 | ||
| - folder2 | ||
| - subfolder/file3 | ||
| ``` | ||
|
|
||
| Similar to `delete` this will exclude the list of file and folders from be transferred to the target. For `ftp` the list of files get excluded from transferring, for `git` they will get resetted from the target repository. | ||
|
|
||
| ### confirm | ||
|
|
||
| ```yaml | ||
| - action: confirm | ||
| arguments: | ||
| question: Do you want to continue? | ||
| ``` | ||
|
|
||
| This action comes handy when degugging the build process, as it will stop the execution and asks the user the questions and wait for `yes` before continuing. Answering sth different will cancel the further execution. | ||
|
|
||
| ### script | ||
|
|
||
| ```yaml | ||
| - action: script | ||
| arguments: | ||
| - echo "Hello world" | ||
| - cp .env.production .env | ||
| ``` | ||
|
|
||
| The `script`-action will run the script from the arguments section line by line. You can use the usual replacement patterns as for other scripts. |
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 |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <?php | ||
|
|
||
| namespace Phabalicious\Artifact\Actions; | ||
|
|
||
|
|
||
| use Phabalicious\Method\ArtifactsBaseMethod; | ||
| use Phabalicious\Validation\ValidationErrorBagInterface; | ||
| use Phabalicious\Validation\ValidationService; | ||
|
|
||
| abstract class ActionBase implements ActionInterface | ||
| { | ||
| protected $arguments= []; | ||
|
|
||
| public function setArguments($arguments) { | ||
| $this->arguments = $arguments; | ||
| } | ||
|
|
||
| protected function getArguments() : array | ||
| { | ||
| return $this->arguments; | ||
| } | ||
|
|
||
| protected function getArgument($name) { | ||
| return $this->arguments[$name] ?? null; | ||
| } | ||
|
|
||
| public function validateConfig($host_config, array $action_config, ValidationErrorBagInterface $errors) { | ||
| $service = new ValidationService($action_config, $errors, sprintf( | ||
| 'host-config.%s.%s.actions', $host_config['configName'], ArtifactsBaseMethod::PREFS_KEY)); | ||
| $service->hasKeys([ | ||
| 'action' => 'Every action needs the type of action to perform', | ||
| 'arguments' => 'Missing arguments for an action' | ||
| ]); | ||
| if (isset($action_config['arguments'])) { | ||
| $service->isArray('arguments', 'arguments need to be an array!'); | ||
| } | ||
|
|
||
| if (!empty($action_config['action']) && is_array($action_config['arguments'])) { | ||
| $service = new ValidationService($action_config['arguments'], $errors, sprintf('%s.arguments', $action_config['action'])); | ||
| $this->validateArgumentsConfig($action_config, $service); | ||
| } | ||
| } | ||
|
|
||
| abstract protected function validateArgumentsConfig(array $action_arguments, ValidationService $validation); | ||
|
|
||
| } |
Oops, something went wrong.