Skip to content

chore: clidocgen: generate consistent docs #7047

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 7, 2023
Merged

chore: clidocgen: generate consistent docs #7047

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bfacf2
chore: clidocgen: ensure same generated docs
mtojek Apr 7, 2023
a2e8b76
fix
mtojek Apr 7, 2023
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
Next Next commit
chore: clidocgen: ensure same generated docs
  • Loading branch information
@mtojek
mtojek committed Apr 7, 2023
commit 0bfacf21cdbfd19a3a9ca9b27cc9ae3871f1a6e2
6 changes: 5 additions & 1 deletion cli/config/file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,5 +125,9 @@ func read(path string) ([]byte, error) {
}

func DefaultDir() string {
return configdir.LocalConfig("coderv2")
configDir := configdir.LocalConfig("coderv2")
if dir := os.Getenv("CLIDOCGEN_CONFIG_DIRECTORY"); dir != "" {
configDir = dir
}
return configDir
}
4 changes: 3 additions & 1 deletion codersdk/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,9 @@ func DefaultCacheDir() string {
// For compatibility with systemd.
defaultCacheDir = dir
}

if dir := os.Getenv("CLIDOCGEN_CACHE_DIRECTORY"); dir != "" {
defaultCacheDir = dir
}
return filepath.Join(defaultCacheDir, "coder")
}

Expand Down
15 changes: 13 additions & 2 deletions scripts/clidocgen/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ type manifest struct {
Routes []route `json:"routes,omitempty"`
}

func unsetCoderEnv() {
func prepareEnv() {
// Unset CODER_ environment variables
for _, env := range os.Environ() {
if strings.HasPrefix(env, "CODER_") {
split := strings.SplitN(env, "=", 2)
Expand All @@ -37,6 +38,16 @@ func unsetCoderEnv() {
}
}
}

// Override default OS values to ensure the same generated results.
err := os.Setenv("CLIDOCGEN_CACHE_DIRECTORY", "~/.cache")
if err != nil {
panic(err)
}
_ = os.Setenv("CLIDOCGEN_CONFIG_DIRECTORY", "~/.config/coderv2")
if err != nil {
panic(err)
}
}

func deleteEmptyDirs(dir string) error {
Expand All @@ -63,7 +74,7 @@ func deleteEmptyDirs(dir string) error {
}

func main() {
unsetCoderEnv()
prepareEnv()

workdir, err := os.Getwd()
if err != nil {
Expand Down