docs: drop remaining proto and buf references

Proto and buf are gone; update the build/generate docs to ogen and openapi.
This commit is contained in:
Kristoffer Dalby
2026-06-18 13:46:00 +00:00
parent add794d190
commit d0b39e7cbb
3 changed files with 13 additions and 20 deletions
+8 -8
View File
@@ -75,9 +75,9 @@ make dev
# Individual targets
make build # build the headscale binary
make test # go test ./...
make fmt # format Go, docs, proto
make lint # lint Go, proto
make generate # regenerate protobuf code (after changes to proto/)
make fmt # format Go and docs
make lint # lint Go
make generate # regenerate ogen code (after changes to openapi/)
make clean # remove build artefacts
# Direct go test invocations
@@ -266,9 +266,9 @@ Key reminders:
Not Conventional Commits. No `feat:`/`chore:`/`docs:` prefixes.
- **Protobuf regeneration**: changes under `proto/` require
`make generate` (which runs `buf generate`) and should land in a
**separate commit** from the callers that use the regenerated types.
- **Code generation**: changes under `openapi/` require `make generate`
(which runs `ogen`) and should land in a **separate commit** from the
callers that use the regenerated types.
- **Formatting** is enforced by `golangci-lint` with `golines` (width 88)
and `gofumpt`. Run `make fmt` or rely on the pre-commit hook.
- **Logging** uses `zerolog`. Prefer single-line chains
@@ -288,6 +288,6 @@ Key reminders:
- **`.claude/agents/` is deprecated.** Do not create new agent files
there. Put behavioural guidance in this file and procedural guidance
in the nearest README.
- **Do not edit `gen/`** — it is regenerated from `proto/` by
- **Do not edit `gen/`** — it is regenerated from `openapi/` by
`make generate`.
- **Proto changes + code changes should be two commits**, not one.
- **Spec changes + code changes should be two commits**, not one.
+3 -9
View File
@@ -92,8 +92,7 @@ Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
### Requirements
To contribute to headscale you would need the latest version of [Go](https://golang.org)
and [Buf](https://buf.build) (Protobuf generator).
To contribute to headscale you would need the latest version of [Go](https://golang.org).
We recommend using [Nix](https://nixos.org/) to setup a development environment. This can
be done with `nix develop`, which will install the tools and give you a shell.
@@ -110,9 +109,6 @@ formatted with [`golines`](https://github.com/segmentio/golines) (width 88) and
Please configure your editor to run the tools while developing and make sure to
run `make lint` and `make fmt` before committing any code.
The **Proto** code is linted with [`buf`](https://docs.buf.build/lint/overview) and
formatted with [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html).
The **docs** are formatted with [`mdformat`](https://mdformat.readthedocs.io).
The **rest** (Markdown, YAML, etc) is formatted with [`prettier`](https://prettier.io).
@@ -122,8 +118,6 @@ Check out the `.golangci.yaml` and `Makefile` to see the specific configuration.
### Install development tools
- Go
- Buf
- Protobuf tools
Install and activate:
@@ -133,8 +127,8 @@ nix develop
### Testing and building
Some parts of the project require the generation of Go code from Protobuf
(if changes are made in `proto/`) and it must be (re-)generated with:
Some parts of the project require generated Go code from the OpenAPI spec
(if changes are made in `openapi/`) and it must be (re-)generated with:
```shell
make generate
+2 -3
View File
@@ -7,9 +7,8 @@
**It might be outdated and it might miss necessary steps**.
Headscale can be built from source using the latest version of [Go](https://golang.org) and [Buf](https://buf.build)
(Protobuf generator). See the [Contributing section in the GitHub
README](https://github.com/juanfont/headscale#contributing) for more information.
Headscale can be built from source using the latest version of [Go](https://golang.org). See the [Contributing
section in the GitHub README](https://github.com/juanfont/headscale#contributing) for more information.
## OpenBSD