👉 You do not need to use this repo to use Dagster Cloud Serverless. When you create an account on Dagster Cloud, it creates a repo for you with the GitHub actions installed. If you want to deploy another project you can use the "Add code locations" button on the Deployments page. This repo provides an alternative way to create a project linked to Dagster Cloud serverless.

Welcome to your Dagster Cloud sample code repo. Here, you can find the code that's being deployed to your Dagster Cloud instance. For more in-depth information, check out our Serverless docs.

Pushing to production will automatically kick off a workflow which will redeploy your code to your prod deployment.

Creating a pull request will kick off a workflow which will create a new Branch Deployment, an ephemeral deployment where you can test your changes.

If you had Dagster Cloud clone and set up this repo for you, no need to follow these instructions.

Click the Use this Template button and provide details for your new repo.

Set up secrets on your newly created repository by navigating to the Settings panel in your repo, clicking Secrets on the sidebar, and selecting Actions. Then, click New repository secret.

Replace the ORGANIZATION_NAME in both .github/workflows/deploy.yml and .github/workflows/branch_deployments.yml with your Dagster cloud organization name:

  DAGSTER_CLOUD_URL: "http://ORGANIZATION_NAME.dagster.cloud"

At this point, the Workflow should complete successfully. If builds are failing, ensure that your secrets are properly set and that your deployment has finished activating.

Now that your GitHub repository is setup with CI/CD to deploy to Dagster Cloud, you can add your own Dagster code. To run this project locally with dagit first install its local developement dependencies

pip install -e ".[dev]"

Once you've done this, you can run:

dagit

to view this repo in Dagster's UI, Dagit.

You can also copy any existing Dagster examples or quickstart projects into this GitHub repository.