synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: disable auto generated tag for CLI docs (#5905)

Browse Source 
This was causing `make gen` to fail as the days went on!
This commit is contained in:
Kyle Carberry
2023-01-29 12:58:12 -06:00
committed by GitHub
parent 2312bc4a6e
commit eaf1b95e70
56 changed files with 11 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/cli/coder.md
View File

@ -68,5 +68,3 @@ coder [flags]
- [coder update](coder_update.md) - Update a workspace - [coder update](coder_update.md) - Update a workspace
- [coder users](coder_users.md) - Manage users - [coder users](coder_users.md) - Manage users
- [coder version](coder_version.md) - Show coder version - [coder version](coder_version.md) - Show coder version
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_config-ssh.md
View File

@ -54,5 +54,3 @@ coder config-ssh [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_create.md
View File

@ -45,5 +45,3 @@ coder create [name] [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_delete.md
View File

@ -37,5 +37,3 @@ coder delete <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_dotfiles.md
View File

@ -45,5 +45,3 @@ coder dotfiles [git_repo_url] [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_list.md
View File

@ -37,5 +37,3 @@ coder list [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_login.md
View File

@ -42,5 +42,3 @@ coder login <url> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_logout.md
View File

@ -35,5 +35,3 @@ coder logout [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_port-forward.md
View File

@ -60,5 +60,3 @@ coder port-forward <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_publickey.md
View File

@ -36,5 +36,3 @@ coder publickey [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_rename.md
View File

@ -35,5 +35,3 @@ coder rename <workspace> <new name> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_reset-password.md
View File

@ -36,5 +36,3 @@ coder reset-password <username> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_restart.md
View File

@ -35,5 +35,3 @@ coder restart <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_scaletest.md
View File

@ -40,5 +40,3 @@ coder scaletest [flags]
- [coder](coder.md) - - [coder](coder.md) -
- [coder scaletest cleanup](coder_scaletest_cleanup.md) - Cleanup any orphaned scaletest resources - [coder scaletest cleanup](coder_scaletest_cleanup.md) - Cleanup any orphaned scaletest resources
- [coder scaletest create-workspaces](coder_scaletest_create-workspaces.md) - Creates many workspaces and waits for them to be ready - [coder scaletest create-workspaces](coder_scaletest_create-workspaces.md) - Creates many workspaces and waits for them to be ready
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_scaletest_cleanup.md
View File

@ -44,5 +44,3 @@ coder scaletest cleanup [flags]
### SEE ALSO ### SEE ALSO
- [coder scaletest](coder_scaletest.md) - Run a scale test against the Coder API - [coder scaletest](coder_scaletest.md) - Run a scale test against the Coder API
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_scaletest_create-workspaces.md
View File

@ -96,5 +96,3 @@ coder scaletest create-workspaces [flags]
### SEE ALSO ### SEE ALSO
- [coder scaletest](coder_scaletest.md) - Run a scale test against the Coder API - [coder scaletest](coder_scaletest.md) - Run a scale test against the Coder API
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_schedule.md
View File

@ -38,5 +38,3 @@ coder schedule { show | start | stop | override } <workspace> [flags]
- [coder schedule show](coder_schedule_show.md) - Show workspace schedule - [coder schedule show](coder_schedule_show.md) - Show workspace schedule
- [coder schedule start](coder_schedule_start.md) - Edit workspace start schedule - [coder schedule start](coder_schedule_start.md) - Edit workspace start schedule
- [coder schedule stop](coder_schedule_stop.md) - Edit workspace stop schedule - [coder schedule stop](coder_schedule_stop.md) - Edit workspace stop schedule
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_schedule_override-stop.md
View File

@ -48,5 +48,3 @@ coder schedule override-stop <workspace-name> <duration from now> [flags]
### SEE ALSO ### SEE ALSO
- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces - [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_schedule_show.md
View File

@ -43,5 +43,3 @@ coder schedule show <workspace-name> [flags]
### SEE ALSO ### SEE ALSO
- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces - [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_schedule_start.md
View File

@ -55,5 +55,3 @@ coder schedule start <workspace-name> { <start-time> [day-of-week] [location] |
### SEE ALSO ### SEE ALSO
- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces - [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_schedule_stop.md
View File

@ -57,5 +57,3 @@ coder schedule stop <workspace-name> { <duration> | manual } [flags]
### SEE ALSO ### SEE ALSO
- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces - [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_server.md
View File

@ -168,5 +168,3 @@ coder server [flags]
- [coder](coder.md) - - [coder](coder.md) -
- [coder server postgres-builtin-serve](coder_server_postgres-builtin-serve.md) - Run the built-in PostgreSQL deployment. - [coder server postgres-builtin-serve](coder_server_postgres-builtin-serve.md) - Run the built-in PostgreSQL deployment.
- [coder server postgres-builtin-url](coder_server_postgres-builtin-url.md) - Output the connection URL for the built-in PostgreSQL deployment. - [coder server postgres-builtin-url](coder_server_postgres-builtin-url.md) - Output the connection URL for the built-in PostgreSQL deployment.
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_server_postgres-builtin-serve.md
View File

@ -35,5 +35,3 @@ coder server postgres-builtin-serve [flags]
### SEE ALSO ### SEE ALSO
- [coder server](coder_server.md) - Start a Coder server - [coder server](coder_server.md) - Start a Coder server
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_server_postgres-builtin-url.md
View File

@ -35,5 +35,3 @@ coder server postgres-builtin-url [flags]
### SEE ALSO ### SEE ALSO
- [coder server](coder_server.md) - Start a Coder server - [coder server](coder_server.md) - Start a Coder server
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_show.md
View File

@ -34,5 +34,3 @@ coder show <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_speedtest.md
View File

@ -37,5 +37,3 @@ coder speedtest <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_ssh.md
View File

@ -46,5 +46,3 @@ coder ssh <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_start.md
View File

@ -35,5 +35,3 @@ coder start <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_state.md
View File

@ -36,5 +36,3 @@ coder state [flags]
- [coder](coder.md) - - [coder](coder.md) -
- [coder state pull](coder_state_pull.md) - - [coder state pull](coder_state_pull.md) -
- [coder state push](coder_state_push.md) - - [coder state push](coder_state_push.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_state_pull.md
View File

@ -33,5 +33,3 @@ coder state pull <workspace> [file] [flags]
### SEE ALSO ### SEE ALSO
- [coder state](coder_state.md) - Manually manage Terraform state to fix broken workspaces - [coder state](coder_state.md) - Manually manage Terraform state to fix broken workspaces
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_state_push.md
View File

@ -33,5 +33,3 @@ coder state push <workspace> <file> [flags]
### SEE ALSO ### SEE ALSO
- [coder state](coder_state.md) - Manually manage Terraform state to fix broken workspaces - [coder state](coder_state.md) - Manually manage Terraform state to fix broken workspaces
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_stop.md
View File

@ -35,5 +35,3 @@ coder stop <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates.md
View File

@ -63,5 +63,3 @@ coder templates [flags]
- [coder templates pull](coder_templates_pull.md) - Download the latest version of a template to a path. - [coder templates pull](coder_templates_pull.md) - Download the latest version of a template to a path.
- [coder templates push](coder_templates_push.md) - Push a new template version from the current directory or as specified by flag - [coder templates push](coder_templates_push.md) - Push a new template version from the current directory or as specified by flag
- [coder templates versions](coder_templates_versions.md) - Manage different versions of the specified template - [coder templates versions](coder_templates_versions.md) - Manage different versions of the specified template
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_create.md
View File

@ -39,5 +39,3 @@ coder templates create [name] [flags]
### SEE ALSO ### SEE ALSO
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_delete.md
View File

@ -35,5 +35,3 @@ coder templates delete [name...] [flags]
### SEE ALSO ### SEE ALSO
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_edit.md
View File

@ -41,5 +41,3 @@ coder templates edit <template> [flags]
### SEE ALSO ### SEE ALSO
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_init.md
View File

@ -34,5 +34,3 @@ coder templates init [directory] [flags]
### SEE ALSO ### SEE ALSO
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_list.md
View File

@ -35,5 +35,3 @@ coder templates list [flags]
### SEE ALSO ### SEE ALSO
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_plan.md
View File

@ -34,5 +34,3 @@ coder templates plan <directory> [flags]
### SEE ALSO ### SEE ALSO
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_pull.md
View File

@ -35,5 +35,3 @@ coder templates pull <name> [destination] [flags]
### SEE ALSO ### SEE ALSO
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_push.md
View File

@ -40,5 +40,3 @@ coder templates push [template] [flags]
### SEE ALSO ### SEE ALSO
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_versions.md
View File

@ -43,5 +43,3 @@ coder templates versions [flags]
- [coder templates](coder_templates.md) - Manage templates - [coder templates](coder_templates.md) - Manage templates
- [coder templates versions list](coder_templates_versions_list.md) - List all the versions of the specified template - [coder templates versions list](coder_templates_versions_list.md) - List all the versions of the specified template
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_templates_versions_list.md
View File

@ -34,5 +34,3 @@ coder templates versions list <template> [flags]
### SEE ALSO ### SEE ALSO
- [coder templates versions](coder_templates_versions.md) - Manage different versions of the specified template - [coder templates versions](coder_templates_versions.md) - Manage different versions of the specified template
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_tokens.md
View File

@ -57,5 +57,3 @@ coder tokens [flags]
- [coder tokens create](coder_tokens_create.md) - Create a tokens - [coder tokens create](coder_tokens_create.md) - Create a tokens
- [coder tokens list](coder_tokens_list.md) - List tokens - [coder tokens list](coder_tokens_list.md) - List tokens
- [coder tokens remove](coder_tokens_remove.md) - Delete a token - [coder tokens remove](coder_tokens_remove.md) - Delete a token
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_tokens_create.md
View File

@ -36,5 +36,3 @@ coder tokens create [flags]
### SEE ALSO ### SEE ALSO
- [coder tokens](coder_tokens.md) - Manage personal access tokens - [coder tokens](coder_tokens.md) - Manage personal access tokens
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_tokens_list.md
View File

@ -34,5 +34,3 @@ coder tokens list [flags]
### SEE ALSO ### SEE ALSO
- [coder tokens](coder_tokens.md) - Manage personal access tokens - [coder tokens](coder_tokens.md) - Manage personal access tokens
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_tokens_remove.md
View File

@ -34,5 +34,3 @@ coder tokens remove [id] [flags]
### SEE ALSO ### SEE ALSO
- [coder tokens](coder_tokens.md) - Manage personal access tokens - [coder tokens](coder_tokens.md) - Manage personal access tokens
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_update.md
View File

@ -39,5 +39,3 @@ coder update <workspace> [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_users.md
View File

@ -39,5 +39,3 @@ coder users [flags]
- [coder users list](coder_users_list.md) - - [coder users list](coder_users_list.md) -
- [coder users show](coder_users_show.md) - Show a single user. Use 'me' to indicate the currently authenticated user. - [coder users show](coder_users_show.md) - Show a single user. Use 'me' to indicate the currently authenticated user.
- [coder users suspend](coder_users_suspend.md) - Update a user's status to 'suspended'. A suspended user cannot log into the platform - [coder users suspend](coder_users_suspend.md) - Update a user's status to 'suspended'. A suspended user cannot log into the platform
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_users_activate.md
View File

@ -41,5 +41,3 @@ coder users activate <username|user_id> [flags]
### SEE ALSO ### SEE ALSO
- [coder users](coder_users.md) - Manage users - [coder users](coder_users.md) - Manage users
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_users_create.md
View File

@ -35,5 +35,3 @@ coder users create [flags]
### SEE ALSO ### SEE ALSO
- [coder users](coder_users.md) - Manage users - [coder users](coder_users.md) - Manage users
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_users_list.md
View File

@ -34,5 +34,3 @@ coder users list [flags]
### SEE ALSO ### SEE ALSO
- [coder users](coder_users.md) - Manage users - [coder users](coder_users.md) - Manage users
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_users_show.md
View File

@ -41,5 +41,3 @@ coder users show <username|user_id|'me'> [flags]
### SEE ALSO ### SEE ALSO
- [coder users](coder_users.md) - Manage users - [coder users](coder_users.md) - Manage users
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_users_suspend.md
View File

@ -41,5 +41,3 @@ coder users suspend <username|user_id> [flags]
### SEE ALSO ### SEE ALSO
- [coder users](coder_users.md) - Manage users - [coder users](coder_users.md) - Manage users
###### Auto generated by spf13/cobra on 27-Jan-2023

2
docs/cli/coder_version.md
View File

@ -34,5 +34,3 @@ coder version [flags]
### SEE ALSO ### SEE ALSO
- [coder](coder.md) - - [coder](coder.md) -
###### Auto generated by spf13/cobra on 27-Jan-2023

11
scripts/clidocgen/main.go
View File

@ -9,6 +9,7 @@ import (
"regexp" "regexp"
"strings" "strings"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc" "github.com/spf13/cobra/doc"
"github.com/coder/coder/buildinfo" "github.com/coder/coder/buildinfo"
@ -63,6 +64,16 @@ func main() {
markdownDocsDir := path.Join(basePath, "docs/cli") markdownDocsDir := path.Join(basePath, "docs/cli")
manifestFilepath := path.Join(basePath, "docs/manifest.json") manifestFilepath := path.Join(basePath, "docs/manifest.json")
// Disables the "Auto generated by spf13/cobra" tag
var disableAutoGenTag func(cmd *cobra.Command)
disableAutoGenTag = func(cmd *cobra.Command) {
for _, c := range cmd.Commands() {
disableAutoGenTag(c)
}
cmd.DisableAutoGenTag = true
}
disableAutoGenTag(cmd)
// Generate markdown // Generate markdown
err = doc.GenMarkdownTree(cmd, markdownDocsDir) err = doc.GenMarkdownTree(cmd, markdownDocsDir)
if err != nil { if err != nil {