document github command (#64)

* Workflow through CLI

Workflow through CLI

sections

link

link

link

link

link

* workflow updation

* fix section

* fix section

* typo

* minor

* removed update pic

* update

doc/user-guide/github.md

@@ -2,6 +2,9 @@
 
 You can use GitHub Actions to deploy your project on each push.
 
+(set-key)=
+## Set Github secret
+
 First, you need to get your [API key](../quickstart/apikey.md). Once you have the API
 key, you need to store it as a GitHub secret in your repository:
 
@@ -10,6 +13,8 @@ key, you need to store it as a GitHub secret in your repository:
 ![](../static/github/set-secret.png)
 
 
+## Initialize project
+
 Then, install the CLI:
 
 ```sh
@@ -31,6 +36,9 @@ ploomber-cloud init
 
 `init` will create a `ploomber-cloud.json` file. For more information on the `init` command, see [](../user-guide/cli.md)
 
+(monitor)=
+## Configure and monitor Github actions
+
 Now, configure GitHub actions by adding [this YAML file](https://github.com/edublancas/cloud-template/blob/main/.github/workflows/ploomber-cloud.yaml) in `.github/workflows/ploomber-cloud.yaml`
 
 Finally, commit and push the new files:
@@ -69,4 +77,48 @@ 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)
+A complete sample project is [available here.](https://github.com/edublancas/cloud-template)
+
+## Configure action through CLI
+
+If your project is already hosted on GitHub, running `ploomber-cloud github` inside your repository folder will prompt configuring a GitHub action for project deployment.
+On confirming with `y` the CLI will create a `ploomber-cloud.yaml` file in the path `.github/workflows`.
+Ensure that the Ploomber Cloud API Key is set as described in [this section](set-key).
+
+```bash
+Please confirm that you want to generate a GitHub workflow file [y/N]: y
+'ploomber-cloud.yaml' file created in the path .github/workflows.
+Please add, commit and push this file along with the 'ploomber-cloud.json' file to trigger an action.
+For details on configuring a GitHub secret please refer: https://docs.cloud.ploomber.io/en/latest/user-guide/github.html
+```
+
+To trigger an action for deploying the project using GitHub actions you need to add, commit and push this file along with the `ploomber-cloud.json`.
+
+Once done, you can monitor progress as discussed [above](monitor).
+
+In case the [workflow template](https://github.com/edublancas/cloud-template/blob/main/.github/workflows/ploomber-cloud.yaml) has been updated, running `ploomber-cloud github` will prompt the user to confirm updating the file:
+
+```bash
+Please confirm that you want to update the GitHub workflow file [y/N]:
+```
+
+On confirming with `y` the CLI will replace the workflow file with the updated one.
+
+Additionally, users are also notified of GitHub workflow file creation or updation as needed while initializing or deploying a project.
+
+If no workflow file is present, running `ploomber-cloud init` or `ploomber-cloud deploy` would display the following information:
+
+```bash
+You may create a GitHub workflow file for deploying your application by running 'ploomber-cloud github'.
+To learn more about GitHub actions refer: https://docs.cloud.ploomber.io/en/latest/user-guide/github.html
+```
+
+If workflow needs an update a relevant message will be displayed:
+
+```bash
+.github/workflows/ploomber-cloud.yaml seems outdated. You may update it by running 'ploomber-cloud github'.
+To learn more about GitHub actions refer: https://docs.cloud.ploomber.io/en/latest/user-guide/github.html
+```
+
+Please review the workflow file and update if needed.
+