Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build: Replace godoc with pkgsite #3643

Merged
merged 1 commit into from
Feb 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions build/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -746,10 +746,10 @@ shell: $(ensure-build-image)
$(DOCKER_RUN_ARGS) \
$(build_tag) bash -l

# run a container with godoc
godoc:
docker run -p 8888:8888 --rm $(common_mounts) -v $(build_path)/.index:/root/.index \
$(build_tag) godoc -http=":8888" -index=true
# run a container with pkgsite
pkgsite:
docker run -p 8888:8888 --rm $(common_mounts) -w $(workdir_path) \
$(build_tag) pkgsite -http=":8888" .

# start cpu profiling pprof with a web ui
pprof-cpu-web:
Expand Down
6 changes: 3 additions & 3 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Table of Contents
* [make pprof-cpu-web](#make-pprof-cpu-web)
* [make pprof-heap-web](#make-pprof-heap-web)
* [make shell](#make-shell)
* [make godoc](#make-godoc)
* [make pkgsite](#make-pkgsite)
* [make build-controller-image](#make-build-controller-image)
* [make build-agones-sdk-image](#make-build-agones-sdk-image)
* [make gen-install](#make-gen-install)
Expand Down Expand Up @@ -655,8 +655,8 @@ Start the web interface for pprof for heap profiling.
#### `make shell`
Run a bash shell with the developer tools (go tooling, kubectl, etc) and source code in it.

#### `make godoc`
Run a container with godoc (search index enabled)
#### `make pkgsite`
Run a container with pkgsite on port 8888

#### `make build-controller-image`
Compile the gameserver controller and then build the docker image
Expand Down
3 changes: 2 additions & 1 deletion build/build-image/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] http://packages.c
ENV PATH /usr/local/go/bin:/go/bin:$PATH

# install go tooling for development, building and testing
RUN go install golang.org/x/tools/cmd/goimports@latest
RUN go install golang.org/x/tools/cmd/goimports@latest && \
go install golang.org/x/pkgsite/cmd/pkgsite@latest

# the kubernetes version for the file
ENV KUBERNETES_VER 1.27.6
Expand Down
Loading