AO3-6707 Add GitPod config (#4800)

* AO3-6707 Add GitPod config

* Remove extensions, ignore port messages

* Better support for in-browser GitPod

* Add details about URL structure

.gitpod.yml

@@ -0,0 +1,17 @@
+tasks:
+  - init: ./script/docker/init.sh
+    command: docker compose up -d web
+
+ports:
+  - port: 3000
+    onOpen: open-browser
+  - port: 3306
+    onOpen: ignore
+  - port: 6379
+    onOpen: ignore
+  - port: 9200
+    onOpen: ignore
+  - port: 9300
+    onOpen: ignore
+  - port: 9400
+    onOpen: ignore

config/environments/development.rb

@@ -82,4 +82,12 @@
     Bullet.rails_logger = true
     Bullet.counter_cache_enable = false
   end
+
+  # GitPod preview support; the preview URL begins with `port#-`, then details about the individual workspace.
+  # For more information about this, refer to https://www.gitpod.io/docs/configure/workspaces/ports#accessing-port-urls.
+  # Example:
+  # GITPOD_WORKSPACE_ID=brianjaustin-otwarchive-w2lj9jd79gm (username-repo-uuid)
+  # GITPOD_WORKSPACE_CLUSTER_HOST=ws-us114.gitpod.io
+  # results in 3000-brianjaustin-otwarchive-w2lj9jd79gm.ws-us114.gitpod.io
+  config.hosts << "3000-#{ENV['GITPOD_WORKSPACE_ID']}.#{ENV['GITPOD_WORKSPACE_CLUSTER_HOST']}" if ENV["GITPOD_WORKSPACE_ID"]
 end

docker-compose.yml

@@ -73,6 +73,8 @@ services:
       dockerfile: ./config/docker/Dockerfile
     environment:
       - RAILS_ENV=development
+      - GITPOD_WORKSPACE_ID=${GITPOD_WORKSPACE_ID:-}
+      - GITPOD_WORKSPACE_CLUSTER_HOST=${GITPOD_WORKSPACE_CLUSTER_HOST:-}
     command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b '0.0.0.0'"
     volumes:
       - .:/otwa