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 # Individual targets
make build # build the headscale binary make build # build the headscale binary
make test # go test ./... make test # go test ./...
make fmt # format Go, docs, proto make fmt # format Go and docs
make lint # lint Go, proto make lint # lint Go
make generate # regenerate protobuf code (after changes to proto/) make generate # regenerate ogen code (after changes to openapi/)
make clean # remove build artefacts make clean # remove build artefacts
# Direct go test invocations # Direct go test invocations
@@ -266,9 +266,9 @@ Key reminders:
Not Conventional Commits. No `feat:`/`chore:`/`docs:` prefixes. Not Conventional Commits. No `feat:`/`chore:`/`docs:` prefixes.
- **Protobuf regeneration**: changes under `proto/` require - **Code generation**: changes under `openapi/` require `make generate`
`make generate` (which runs `buf generate`) and should land in a (which runs `ogen`) and should land in a **separate commit** from the
**separate commit** from the callers that use the regenerated types. callers that use the regenerated types.
- **Formatting** is enforced by `golangci-lint` with `golines` (width 88) - **Formatting** is enforced by `golangci-lint` with `golines` (width 88)
and `gofumpt`. Run `make fmt` or rely on the pre-commit hook. and `gofumpt`. Run `make fmt` or rely on the pre-commit hook.
- **Logging** uses `zerolog`. Prefer single-line chains - **Logging** uses `zerolog`. Prefer single-line chains
@@ -288,6 +288,6 @@ Key reminders:
- **`.claude/agents/` is deprecated.** Do not create new agent files - **`.claude/agents/` is deprecated.** Do not create new agent files
there. Put behavioural guidance in this file and procedural guidance there. Put behavioural guidance in this file and procedural guidance
in the nearest README. 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`. `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 ### Requirements
To contribute to headscale you would need the latest version of [Go](https://golang.org) To contribute to headscale you would need the latest version of [Go](https://golang.org).
and [Buf](https://buf.build) (Protobuf generator).
We recommend using [Nix](https://nixos.org/) to setup a development environment. This can 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. 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 Please configure your editor to run the tools while developing and make sure to
run `make lint` and `make fmt` before committing any code. 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 **docs** are formatted with [`mdformat`](https://mdformat.readthedocs.io).
The **rest** (Markdown, YAML, etc) is formatted with [`prettier`](https://prettier.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 ### Install development tools
- Go - Go
- Buf
- Protobuf tools
Install and activate: Install and activate:
@@ -133,8 +127,8 @@ nix develop
### Testing and building ### Testing and building
Some parts of the project require the generation of Go code from Protobuf Some parts of the project require generated Go code from the OpenAPI spec
(if changes are made in `proto/`) and it must be (re-)generated with: (if changes are made in `openapi/`) and it must be (re-)generated with:
```shell ```shell
make generate make generate
+2 -3
View File
@@ -7,9 +7,8 @@
**It might be outdated and it might miss necessary steps**. **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) Headscale can be built from source using the latest version of [Go](https://golang.org). See the [Contributing
(Protobuf generator). See the [Contributing section in the GitHub section in the GitHub README](https://github.com/juanfont/headscale#contributing) for more information.
README](https://github.com/juanfont/headscale#contributing) for more information.
## OpenBSD ## OpenBSD