From e8a4cf4a2099e35dc69e8beabcf83f280d86e97f Mon Sep 17 00:00:00 2001 From: Nils Dijk Date: Thu, 3 Aug 2023 13:39:09 +0000 Subject: [PATCH] workflow for devcontainer trigger on anybranch --- .devcontainer/.vscode/launch.json | 3 --- .github/workflows/devcontainer.yml | 2 -- CONTRIBUTING.md | 4 ++-- 3 files changed, 2 insertions(+), 7 deletions(-) diff --git a/.devcontainer/.vscode/launch.json b/.devcontainer/.vscode/launch.json index 595c18852..00b12ac4f 100644 --- a/.devcontainer/.vscode/launch.json +++ b/.devcontainer/.vscode/launch.json @@ -1,7 +1,4 @@ { - // Use IntelliSense to learn about possible attributes. - // Hover to view descriptions of existing attributes. - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ { diff --git a/.github/workflows/devcontainer.yml b/.github/workflows/devcontainer.yml index 8358a87c7..47a06ebcc 100644 --- a/.github/workflows/devcontainer.yml +++ b/.github/workflows/devcontainer.yml @@ -2,8 +2,6 @@ name: "Build devcontainer" on: push: - branches: - - "dev/devcontainer" paths: - ".devcontainer/**" workflow_dispatch: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65030a84e..a7b44adac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ why we ask this as well as instructions for how to proceed, see the ### Devcontainer / Github Codespaces -The easiest way to start contributing is via our devcontainer. This container works both locally in visual studio code with docker-desktop/docker-for-mac as well as [Github Codespaces](https://github.com/features/codespaces). To open the project in vscode you will need the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). To start the project in Codespaces, please follow the guidance from Github +The easiest way to start contributing is via our devcontainer. This container works both locally in visual studio code with docker-desktop/docker-for-mac as well as [Github Codespaces](https://github.com/features/codespaces). To open the project in vscode you will need the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). For codespaces you will need to [create a new codespace](https://codespace.new/citusdata/citus). With the extension installed you can run the following from the command pallet to get started @@ -31,7 +31,7 @@ This will create an isolated Workspace in vscode, complete with all tools requir To quickly start we suggest splitting your terminal once to have two shells. The left one in the `/workspaces/citus`, the second one changed to `/data`. The left terminal will be used to interact with the project, the right one with a testing cluster. -To get citus installed from source we run `make install -sj8` in the first terminal, adjust `j8` to suite number of cores you have available. Once installed you can start a Citus cluster in the second terminal via `citus_dev make citus`. The cluster will run in the background, and can be interacted with via `citus_dev`. To get an overview of the available commands. +To get citus installed from source we run `make install -sj8` in the first terminal, adjust `j8` to suite to the number of cores you have available. Once installed you can start a Citus cluster in the second terminal via `citus_dev make citus`. The cluster will run in the background, and can be interacted with via `citus_dev`. To get an overview of the available commands. With the Citus cluster running you can connect to the coordinator in the first terminal via `psql -p9700`. Because the coordinator is the most common entrypoint the `PGPORT` environment is set accordingly, so a simple `psql` will connect directly to the coordinator.