diff --git a/README.md b/README.md index 07f0bc8..0572000 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # drupal-cleanup-action -Cleanup older deployments + +SSH into a remote server and cleanup older deployments (directories) with defined pattern. Preserve only the newest number of configured directories. + +Usage: + +``` + - name: 'Cleanup old releases' + uses: eaudeweb/drupal-cleanup-action@1.x + with: + ssh_user: ${{ secrets.TEST_SSH_USER }} + ssh_host: ${{ secrets.TEST_SSH_HOST }} + ssh_key: ${{ secrets.TEST_SSH_KEY }} + cleanup_dir: /var/www/artifacts/example.org + pattern: release-* + retain: 5 +```