From 7bc3ee41c03ff90f7b43c7aacb11c9dd471019a8 Mon Sep 17 00:00:00 2001
From: Florian Loitsch <florian@loitsch.com>
Date: Fri, 4 Oct 2024 09:56:04 +0200
Subject: [PATCH] Add documentation on railway setup.

---
 .github/workflows/ci.yml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 3eb3c80..232a714 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -138,6 +138,13 @@ jobs:
           (github.event_name == 'push' && github.ref == 'refs/heads/main')
         env:
           RAILWAY_TOKEN: ${{ secrets.RAILWAY_TOKEN }}
+        # pkg-dev.toit.io is set up as follows:
+        # - Source image: ghcr.io/toitware/tpkg_registry:main
+        # - Variables:
+        #    REGISTRY_BRANCH="main"
+        #    REGISTRY_SSH_KEY="-----BEGIN OPENSSH PRIVATE KEY----- ... -----END OPENSSH PRIVATE KEY"
+        #    REGISTRY_SSH_KEY_FILE="/secrets/ssh-key"
+        #    REGISTRY_URL="github.com/toitware/registry"
         run: |
           railway link --project-id $RAILWAY_PROJECT_ID --service $RAILWAY_DEV_SERVICE_ID
           railway redeploy -y
@@ -146,6 +153,13 @@ jobs:
         if: github.event.inputs.redeploy == 'true' || github.event_name == 'release'
         env:
           RAILWAY_TOKEN: ${{ secrets.RAILWAY_TOKEN }}
+        # pkg.toit.io is set up as follows:
+        # - Source image: ghcr.io/toitware/tpkg_registry:latest
+        # - Variables:
+        #    REGISTRY_BRANCH="main"
+        #    REGISTRY_SSH_KEY="-----BEGIN OPENSSH PRIVATE KEY----- ... -----END OPENSSH PRIVATE KEY"
+        #    REGISTRY_SSH_KEY_FILE="/secrets/ssh-key"
+        #    REGISTRY_URL="github.com/toitware/registry"
         run: |
           railway link --project-id $RAILWAY_PROJECT_ID --service $RAILWAY_SERVICE_ID
           railway redeploy -y