chore: add mise toolchain support (#699)

Author: lox

.gitignore

@@ -3,3 +3,5 @@ dist/
 buildkite.yaml
 .bk.yaml
 build-logs-*
+mise.local.toml
+.mise.local.toml

AGENT.md

@@ -1,9 +1,12 @@
 This project is the Buildkite CLI (`bk`)
 
 ## Commands
-- Test: `go test ./...`
-- Lint: `docker-compose -f .buildkite/docker-compose.yaml run golangci-lint golangci-lint run`
-- Generate: `go generate` (required after GraphQL changes)
+- Bootstrap: `mise install`
+- Hooks: `mise run hooks`
+- Format: `mise run format`
+- Test: `mise run test`
+- Lint: `mise run lint`
+- Generate: `mise run generate` (required after GraphQL changes)
 - Run: `go run main.go`
 
 ## Environment
@@ -15,5 +18,6 @@ This project is the Buildkite CLI (`bk`)
 - CLI commands: `pkg/cmd/`
 
 ## Notes
+- `mise.toml` pins the local Go/tool versions
 - CI: https://buildkite.com/buildkite/buildkite-cli
 - Always format after changing code

CONTRIBUTING.md

@@ -6,13 +6,19 @@ We welcome contributions from the community to make Buildkite CLI, `bk`, project
 
 To get started with contributing, please follow these steps:
 
-1. Fork the repository 
-2. Create a feature branch with a nice name (`git checkout -b cli-new-feature`) for your changes
-3. Write your code
-    * We use `golangci-lint` and would be good to use the same in order to pass a PR merge. You can use `docker-compose -f .buildkite/docker-compose.yaml run golangci-lint golangci-lint run` for that. 
-    * Make sure the tests are passing by running go test ./...
-5. Commit your changes and push them to your forked repository.
-7. Submit a pull request with a detailed description of your changes and linked to any relevant issues.
+1. Fork the repository.
+2. Create a feature branch with a nice name (`git checkout -b cli-new-feature`) for your changes.
+3. Install [mise](https://mise.jdx.dev/) and run `mise install`.
+4. Install the local git hooks with `mise run hooks`.
+5. Write your code.
+6. Run the local checks before opening a pull request.
+   * Format the code with `mise run format`.
+   * Lint with `mise run lint`.
+   * Make sure the tests pass with `mise run test`.
+   * Run `mise run generate` after GraphQL changes. If you need to refresh `schema.graphql`, set `BUILDKITE_GRAPHQL_TOKEN` first.
+   * If you prefer the containerized lint setup, `docker-compose -f .buildkite/docker-compose.yaml run golangci-lint golangci-lint run` still works.
+7. Commit your changes and push them to your forked repository.
+8. Submit a pull request with a detailed description of your changes and links to any relevant issues.
 
 The team maintaining this codebase will review your PR and start a CI build for it. For security reasons, we don't automatically run CI against forked repos, and a human will review your PR prior to its CI running.
 

README.md

@@ -28,11 +28,20 @@ We'd love to hear any feedback and questions you might have. Please [file an iss
 
 ## Development
 
-Developed using Go 1.20+ with modules.
+This repository uses [mise](https://mise.jdx.dev/) to pin Go and the main
+local development tools.
 
 ```bash
 git clone git@github.com:buildkite/cli.git
 cd cli/
-go generate
+mise install
+mise run hooks
+mise run format
+mise run lint
+mise run test
+mise run generate
 go run main.go --help
 ```
+
+`mise.toml` pins Go `1.26.1` to match the current release build image. The
+module itself remains compatible with Go `1.25.0` as declared in `go.mod`.

mise.toml

@@ -0,0 +1,32 @@
+# Pinned local toolchain for contributors. The Go version matches the
+# repository's current release build image; the module minimum stays in go.mod.
+[tools]
+go = "1.26.1"
+golangci-lint = "2.11.3"
+lefthook = "2.1.4"
+"aqua:mvdan/gofumpt" = "0.9.2"
+"aqua:goreleaser/goreleaser" = "2.14.3"
+
+[tasks.format]
+description = "Format Go files with gofumpt"
+run = "gofumpt -w ."
+
+[tasks.lint]
+description = "Run golangci-lint with the repository configuration"
+run = "golangci-lint run --verbose --timeout 3m"
+
+[tasks.test]
+description = "Run the Go test suite"
+run = "go test ./..."
+
+[tasks.generate]
+description = "Regenerate the GraphQL client code"
+run = "go generate ./cmd/generate"
+
+[tasks.hooks]
+description = "Install the repository git hooks"
+run = "lefthook install"
+
+[tasks.ci]
+description = "Run the main local CI checks"
+depends = ["lint", "test"]