Skip to content

Commit

Permalink
Improve documentation and default behavior
Browse files Browse the repository at this point in the history
Improve documentation by referencing the robo-digipolis-deploy
documentation about providing database connection details.

Fix a broken anchor link.

By default, create a backup and rollback during deploy. Add
documentation for the option in the `properties.yml` documentation.
  • Loading branch information
Jelle-S committed Nov 17, 2022
1 parent 4a5d856 commit d8c7cbb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Used by digipolis, generic commands/skeleton do execute deploys and syncs betwee

## Getting started

To let this package know about your database configuration, please read
[the robo-digipolis-deploy package's documentation]
(https://github.com/district09/robo-digipolis-deploy#use-events-for-default-configuration).

We make a couple of assumptions, most of which can be overwritten. See
[default.properties.yml](src/default.properties.yml) for all default values, and
[the properties.yml documentation](#propertiesyml) for all available
Expand Down Expand Up @@ -80,6 +84,9 @@ remote:
# should get symlinked to since the uploaded files are shared across releases.
# See `symlinks` below.
filesdir: '${remote.appdir}/files'
# Whether or not to create a backup (and corresponding restore task on
# rollback during deploy.
createbackup: true
# The folder where to store backups that are created before running updates.
backupsdir: '${remote.appdir}/backups'
# The symlinks to create when deploying, in format target:link
Expand Down Expand Up @@ -566,9 +573,9 @@ machine.

The handler for this event should return a task that will switch the `current`
symlink to the previous release (mostly used on rollback of a failed release).
The difference with the (digipolis:remote-switch-previous)[#digipolis-remote-switch-previous]
The difference with the (digipolis:remote-switch-previous)[#digipolisremote-switch-previous]
event is that this will be executed directly on the host, and thus doesn't need
an ssh connection, while the (digipolis:remote-switch-previous)[#digipolis-remote-switch-previous]
an ssh connection, while the (digipolis:remote-switch-previous)[#digipolisremote-switch-previous]
will be executed from your deployment server, or your local machine, and thus
will need an ssh connection to the host.

Expand Down
2 changes: 1 addition & 1 deletion src/default.properties.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ remote:
configdir: '${remote.appdir}/config'
filesdir: '${remote.appdir}/files'
backupsdir: '${remote.appdir}/backups'
createbackup: false
createbackup: true
symlinks:
- '${remote.webdir}:${remote.currentdir}'
opcache:
Expand Down

0 comments on commit d8c7cbb

Please sign in to comment.