From cd9a24f78f36619732f6d1a3da113f690e8c9332 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 17 Aug 2022 23:08:18 +0000 Subject: [PATCH 1/4] docs: update CONTRIBUTING requirements --- docs/CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 6d3a749ac50aa..ab6b50f1b8e0e 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,7 +2,15 @@ ## Requirements -Coder requires Go 1.18+, Node 14+, and GNU Make. +You'll need the following tools: +- Go 1.18+ +- Node 14+ +- GNU Make +- [`shfmt`](https://github.com/mvdan/sh#shfmt) +- [`nfpm`](https://nfpm.goreleaser.com/install/) +- [`zstd`](https://github.com/horta/zstd.install) +- [`pg_dump`] + - on macOS, run `brew install libpq zstd` > **Note**: > Use [Nix](https://nix.dev/) for a one-command setup: `nix-shell` @@ -11,7 +19,7 @@ Coder requires Go 1.18+, Node 14+, and GNU Make. Use the following `make` commands and scripts in development: -- `make dev` runs the frontend and backend development server +- `./scripts/develop.sh` runs the frontend and backend development server - `make build` compiles binaries and release packages - `make install` installs binaries to `$GOPATH/bin` - `make test` From 53852e65704c228a6c62972ed818467336e5a479 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Aug 2022 08:26:36 -0700 Subject: [PATCH 2/4] Update docs/CONTRIBUTING.md --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ab6b50f1b8e0e..5888c8639524d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -7,7 +7,7 @@ You'll need the following tools: - Node 14+ - GNU Make - [`shfmt`](https://github.com/mvdan/sh#shfmt) -- [`nfpm`](https://nfpm.goreleaser.com/install/) +- [`nfpm`](https://nfpm.goreleaser.com/install) - [`zstd`](https://github.com/horta/zstd.install) - [`pg_dump`] - on macOS, run `brew install libpq zstd` From b963bef883bf5f3d05c1eaae80cb55216ca7d8ab Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Aug 2022 15:33:24 +0000 Subject: [PATCH 3/4] refactor: remove dev from Makefile --- Makefile | 5 ----- 1 file changed, 5 deletions(-) diff --git a/Makefile b/Makefile index 997cbc0d4e460..08df31dfceea1 100644 --- a/Makefile +++ b/Makefile @@ -63,11 +63,6 @@ coderd/database/dump.sql: $(wildcard coderd/database/migrations/*.sql) coderd/database/querier.go: coderd/database/sqlc.yaml coderd/database/dump.sql $(wildcard coderd/database/queries/*.sql) coderd/database/generate.sh -# This target is deprecated, as GNU make has issues passing signals to subprocesses. -dev: - @echo Please run ./scripts/develop.sh manually. -.PHONY: dev - fmt/prettier: @echo "--- prettier" cd site From 6aa9e835a93e1c5d61cf655ddeda4699582875a1 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Aug 2022 16:18:20 +0000 Subject: [PATCH 4/4] fixup: add linux section --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 5888c8639524d..184c1f4cca863 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -8,9 +8,9 @@ You'll need the following tools: - GNU Make - [`shfmt`](https://github.com/mvdan/sh#shfmt) - [`nfpm`](https://nfpm.goreleaser.com/install) -- [`zstd`](https://github.com/horta/zstd.install) - [`pg_dump`] - on macOS, run `brew install libpq zstd` + - on Linux, install [`zstd`](https://github.com/horta/zstd.install) > **Note**: > Use [Nix](https://nix.dev/) for a one-command setup: `nix-shell`