Automatically deploy session backend code to your Jamsocket service.

To use this Jamsocket deploy action, add the action to your Github Workflow.

Here's an example of an action that will run whenever code is pushed to main.

To use this example, paste the code snippet below in a file called deploy.yml. Add that file to the .github/workflows directory in the root of your repository. When you push your code to main, you can view the running action in the Actions tab of your Github repository.

name: Deploy to Jamsocket
on:
  push:
    branches: [ "main" ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Deploy to Jamsocket
        uses: jamsocket/[email protected]
        with:
          jamsocket_api_token: ${{ secrets.JAMSOCKET_API_TOKEN }}
          jamsocket_account: my-jamsocket-account
          jamsocket_service: my-jamsocket-service
          docker_build_context: ./server
          dockerfile_path: ./server/Dockerfile

The following options must be configured in order to make a deployment. As shown in the example above, the following options are added under the with section of your Deploy to Jamsocket step.

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 in the Jamsocket dashboard on the service page under Docker Images.