feat: devbox #572

jolheiser · 2023-09-03T04:25:10Z

jolheiser commented

2023-09-03 04:25:10 +00:00

This PR adds a devbox config to the repo.
This may be beneficial to anyone interested in nix but doesn't want to deal with the language, or anyone interested in an easy way to start development for tea.

With devbox installed, devbox shell should drop you into a shell with go 1.20.x, gopls (language server), and make for build targets available.
I didn't want to duplicate all of our Makefile, but I did add a single script devbox run build because it also has the packages above available, so at the very least a user with devbox should be able to build the project.

We don't have CGO, so nothing extra should be required that I can think of, and our linters are invoked via go run so they should also work since the go package would be available.

As a quick note, I am more familiar with nix itself than I am with devbox, but I think this could potentially help anyone wanting to quickly contribute.

If you want to get really meta and are a nix user, you could even run nix run nixpkgs#devbox shell to drop into the shell.

Another alternative would be to write an actual flake with a devShell, however I think devbox is a nice in-between. Anyone comfortable with nix can probably whip up a dev environment fairly easily without devbox.

This PR adds a [devbox](https://www.jetpack.io/devbox/) config to the repo. This may be beneficial to anyone interested in nix but doesn't want to deal with the language, or anyone interested in an easy way to start development for `tea`. With `devbox` installed, `devbox shell` should drop you into a shell with `go 1.20.x`, `gopls` (language server), and `make` for build targets available. I didn't want to duplicate all of our Makefile, but I did add a single script `devbox run build` because it also has the packages above available, so at the very least a user with `devbox` should be able to build the project. We don't have CGO, so nothing extra should be required that I can think of, and our linters are invoked via `go run` so they should also work since the `go` package would be available. ----- As a quick note, I am more familiar with nix itself than I am with devbox, but I think this could potentially help anyone wanting to quickly contribute. If you want to get really meta and are a nix user, you could even run `nix run nixpkgs#devbox shell` to drop into the shell. Another alternative would be to write an actual flake with a devShell, however I think `devbox` is a nice in-between. Anyone comfortable with nix can probably whip up a dev environment fairly easily without `devbox`.

jolheiser added 1 commit 2023-09-03 04:25:11 +00:00

feat: devbox

check-and-test / check-and-test (pull_request) Failing after 1m7s

Details

1c2d9ab58d

Signed-off-by: jolheiser <john.olheiser@gmail.com>

techknowlogick added 1 commit 2023-09-08 01:41:34 +00:00

Merge branch 'main' into devbox

check-and-test / check-and-test (pull_request) Successful in 1m15s

Details

4648715e70

techknowlogick merged commit 66b4decdd1 into main

2023-09-08 15:24:52 +00:00

techknowlogick referenced this issue from a commit

2023-09-08 15:24:53 +00:00

feat: devbox (#572)

jolheiser deleted branch devbox

2023-09-08 15:58:34 +00:00

Sign in to join this conversation.

No reviewers

No Milestone

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: gitea/tea#572