Skip to content

Commit

Permalink
deployment section
Browse files Browse the repository at this point in the history
  • Loading branch information
feliciachang committed May 30, 2024
1 parent e53d6b3 commit 8166688
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Jamsocket Deploy Action
# Jamsocket Deploy Action 🚀

Automatically deploy session backend code to your Jamsocket service.

## Configuration

To use this Jamsocket deploy action, add the action to your [Github Workflow](https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow).

Here's an example of an action that will run whenever code is pushed to `main`.
Here's an example of an action that will run whenever code is pushed to `main`. This action would live under the `.github/workflows` folder.

```yaml
```yaml filename=depoy.yaml
name: Deploy to Jamsocket
on:
push:
Expand Down Expand Up @@ -41,3 +41,7 @@ The following options must be configured in order to make a deployment. As show
| jamsocket_service | The name of the Jamsocket service you are pushing your code to. | `with` | Yes |
| docker_build_context | The path to your Docker build context, which should be the same as the WORKDIR specified in your Dockerfile. | `with` | Yes |
| dockerfile_path | The path to your Dockerfile. | `with` | Yes |

## Deployment

When a Jamsocket deployment is successful, you will find that a new image has been pushed to your Jamsocket service. You can find new images on the service page under `Docker Images`.

0 comments on commit 8166688

Please sign in to comment.