Add example files on how to override action

Signed-off-by: Riddhesh Sanghvi <[email protected]>

Author: mrrobot47

example/addon.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Deployer;
+
+/**
+ * Define your custom tasks as shown below.
+ */
+desc( 'Some task' );
+task( 'some:task', function () {
+	// task code here.
+} );
+
+
+desc( 'Some other task' );
+task( 'some:othertask', function () {
+	// task code here.
+} );
+
+/**
+ * Update the tasks variable and add your tasks in the order where they should be.
+ * You can also remove any tasks which you may not need.
+ */
+$tasks = [
+	'deploy:prepare',
+	'deploy:unlock',
+	'deploy:lock',
+	'deploy:release',
+	'rsync',
+	'wp:config',
+	'some:task', // Adding custom task in $tasks variable.
+	'some:othertask', // Adding custom task in $tasks variable.
+	'cachetool:download',
+	'deploy:shared',
+	'deploy:symlink',
+	'permissions:set',
+	'opcache:reset',
+	'core_db:update',
+	'deploy:unlock',
+	'cleanup',
+];
+
+// Stop editing now. The above given tasks will be run by deploy.php of this action now.

example/addon.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+function some_custom_function() {
+	# function logic goes here.
+	echo 'Custom logic goes here'
+}
+
+# Overriding the main function of `main.sh`.
+# This is compulsory. You can take the functions that are run
+# in `main.sh`'s `main` functions else condition and
+# add edit/remove them as well as add your function
+# where needed for custom deployment changes.
+function main() {
+	setup_hosts_file
+	check_branch_in_hosts_file
+	setup_ssh_access
+	maybe_install_node_dep
+	maybe_run_node_build
+	maybe_install_submodules
+	some_custom_function # Adding the custom function in the order where needed.
+	setup_wordpress_files
+	deploy
+}
+
+main