Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document deploy --watch #56

Merged
merged 5 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added doc/static/github/logs-watch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 7 additions & 4 deletions doc/user-guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,12 @@ Once the command exits, you can deploy:
ploomber-cloud deploy
```

The `deploy` command will print a URL that you can visit to track deployment progress.
The `deploy` command will print a URL that you can visit to track deployment progress. If you would like to track progress in the command line,
add the `--watch` flag.

```sh
ploomber-cloud deploy --watch
```

## Configure an existing project

Expand All @@ -59,6 +64,4 @@ Then, execute:

```sh
ploomber-cloud deploy
```

The `deploy` command will print a URL that you can visit to track deployment progress.
```
21 changes: 19 additions & 2 deletions doc/user-guide/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,25 @@ Once you push, you can monitor progress from GitHub. First, go to the actions se

Then, click on the most recent run, and you'll see the logs:

![](../static/github/logs.png)
![](../static/github/logs-watch.png)

In the logs, you will see updates on the progress of the deployment. You'll also see a URL to your project dashboard where you can check its status.
Once the deployment has succeeded, it will return a URL to view your deployed project.

If you would prefer to track progress only through the project dashboard, you can remove `--watch` from the `deploy` command in your `ploomber-cloud.yaml`:

```yaml
- name: Deploy
env:
PLOOMBER_CLOUD_KEY: ${{ secrets.PLOOMBER_CLOUD_KEY }}
run: |
ploomber-cloud deploy # removed '--watch' here
```

Removing `--watch` means deployment updates won't be output to the logs, but you will still be able to track its progress through the URL.

In the logs, you'll see a URL that you can use to track progress.
Without `--watch`, the logs will look like this:

![](../static/github/logs.png)

A complete sample project is [available here.](https://github.com/edublancas/cloud-template)