From 43c8eb9796eb55843e9cfbc7d135cdb35a4b1aae Mon Sep 17 00:00:00 2001 From: Niloth P <20315308+Niloth-p@users.noreply.github.com> Date: Thu, 14 Nov 2024 17:27:59 +0530 Subject: [PATCH] integration-docs: Update Capistrano for new doc format. Part of zulip#29592. --- templates/zerver/integrations/capistrano.md | 30 +++++++++++---------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/templates/zerver/integrations/capistrano.md b/templates/zerver/integrations/capistrano.md index a97ed53eb0..499e855331 100644 --- a/templates/zerver/integrations/capistrano.md +++ b/templates/zerver/integrations/capistrano.md @@ -1,5 +1,9 @@ +# Zulip Capistrano Integration + Get Zulip notifications for your Capistrano deploys! +{start_tabs} + 1. {!create-an-incoming-webhook.md!} 1. {!download-python-bindings.md!} @@ -14,26 +18,24 @@ Get Zulip notifications for your Capistrano deploys! desc "Post a message to Zulip after deploy" task :humbug do run_locally "echo 'I just deployed to #{stage}! :tada:' | zulip-send \ - --user capistrano-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \ + --user --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \ --site={{ api_url }} \ --stream commits --subject deployments || true" end end - The `--user` and `--api-key` should be the email and API key of the Zulip - bot created above. You can also put these values in a `~/.zuliprc` file on - your Capistrano machine. See our [API docs](/api/) for instructions on - creating that file. - -!!! tip "" - - You can change the `deploy` above to another step of - your deployment process, if you'd like the notification to fire - at a different time. See [Capistrano's Before/After Hooks page][1] - for more information! - -[1]: https://capistranorb.com/documentation/getting-started/before-after/ +{end_tabs} {!congrats.md!} ![Capistrano bot message](/static/images/integrations/capistrano/001.png) + +### Configuration Options + +Customize the notification trigger by replacing `deploy` with any stage of your deployment process. + +### Related documentation + +[Capistrano's Before/After Hooks page][1] + +[1]: https://capistranorb.com/documentation/getting-started/before-after/