Skip to content

chore: remove gomarkdoc docs generation recipes #28

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
retr0h merged 1 commit into from
Mar 29, 2026
Merged

chore: remove gomarkdoc docs generation recipes #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 1 addition & 35 deletions go.just
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
git_root := `git rev-parse --show-toplevel`
main_package := env("JUST_MAIN_PACKAGE", "main.go")
coverage_dir := env("JUST_COVERAGE_DIR", ".coverage")
docs_dir := env("JUST_DOCS_DIR", "docs/gen")
os_tags := if os() == "linux" { `if grep -iq 'ubuntu' /etc/os-release 2>/dev/null; then echo '-tags=ubuntu'; fi` } else { "" }

# --- Private dependency recipes ---
Expand All @@ -45,15 +44,11 @@ _vet-deps:
_cov-deps:
go get -tool github.com/boumenot/gocover-cobertura

[private]
_docs-deps:
go get -tool github.com/princjef/gomarkdoc/cmd/gomarkdoc

# --- Setup ---

# Install all tool dependencies
[group('setup')]
deps: _fmt-deps _vet-deps _cov-deps _docs-deps
deps: _fmt-deps _vet-deps _cov-deps

# Module maintenance (download + tidy)
[group('setup')]
Expand Down Expand Up @@ -140,32 +135,3 @@ fmt-check: _fmt-deps
[group('codegen')]
generate:
go generate ./...

# --- Docs ---

# Generate Go package documentation
[group('docs')]
docs: _docs-deps
#!/usr/bin/env bash
set -euo pipefail
mkdir -p {{ docs_dir }}
tmpl='{{ "{{" }}.Name{{ "}}" }}'
for pkg in $(go list ./...); do
name=$(go list -f "$tmpl" "$pkg")
[[ "$name" == "mocks" || "$name" == "main" ]] && continue
go tool github.com/princjef/gomarkdoc/cmd/gomarkdoc \
-o "{{ docs_dir }}/${name}.md" "$pkg"
done

# Check if generated docs are up to date
[group('docs')]
docs-check: _docs-deps
#!/usr/bin/env bash
set -euo pipefail
tmpl='{{ "{{" }}.Name{{ "}}" }}'
for pkg in $(go list ./...); do
name=$(go list -f "$tmpl" "$pkg")
[[ "$name" == "mocks" || "$name" == "main" ]] && continue
go tool github.com/princjef/gomarkdoc/cmd/gomarkdoc \
-c -o "{{ docs_dir }}/${name}.md" "$pkg"
done
Loading