Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitcde02ed

Browse files
committed
fix: improve coder_script related docs
1 parent7a00ae7 commitcde02ed

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

‎provider/agent.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import (
1717
funcagentResource()*schema.Resource {
1818
return&schema.Resource{
1919
Description:"Use this resource to associate an agent.",
20-
CreateContext:func(ctx context.Context,resourceData*schema.ResourceData,iinterface{}) diag.Diagnostics {
20+
CreateContext:func(_ context.Context,resourceData*schema.ResourceData,iinterface{}) diag.Diagnostics {
2121
// This should be a real authentication token!
2222
resourceData.SetId(uuid.NewString())
2323
err:=resourceData.Set("token",uuid.NewString())
@@ -121,7 +121,7 @@ func agentResource() *schema.Resource {
121121
},
122122
"startup_script": {
123123
ForceNew:true,
124-
Description:"A script to run after the agent starts. The script should exit when it is done to signal that the agent is ready.",
124+
Description:`A script to run after the agent starts. The script should exit when it is done to signal that the agent is ready. This option is an alias for defining a "coder_script" resource with "run_on_start" set to true.`,
125125
Type:schema.TypeString,
126126
Optional:true,
127127
},
@@ -138,7 +138,7 @@ func agentResource() *schema.Resource {
138138
Type:schema.TypeString,
139139
ForceNew:true,
140140
Optional:true,
141-
Description:"A script to run before the agent is stopped. The script should exit when it is done to signal that the workspace can be stopped.",
141+
Description:`A script to run before the agent is stopped. The script should exit when it is done to signal that the workspace can be stopped. This option is an alias for defining a "coder_script" resource with "run_on_stop" set to true.`,
142142
},
143143
"shutdown_script_timeout": {
144144
Type:schema.TypeInt,
@@ -197,7 +197,7 @@ func agentResource() *schema.Resource {
197197
Type:schema.TypeString,
198198
ForceNew:true,
199199
Optional:true,
200-
Description:"This option sets the behavior of the`startup_script`. When set to\"blocking\", the startup_script must exit before the workspace is ready. When set to\"non-blocking\", the startup_script may run in the background and the workspace will be ready immediately. Default is\"non-blocking\", although\"blocking\" is recommended.",
200+
Description:`This option sets the behavior of the"startup_script". When set to "blocking", the startup_script must exit before the workspace is ready. When set to "non-blocking", the startup_script may run in the background and the workspace will be ready immediately. Default is "non-blocking", although "blocking" is recommended. This option is an alias for defining a "coder_script" resource with "start_blocks_login" set to true (blocking).`,
201201
ValidateFunc:validation.StringInSlice([]string{"blocking","non-blocking"},false),
202202
ConflictsWith: []string{"login_before_ready"},
203203
},

‎provider/script.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ var ScriptCRONParser = cron.NewParser(cron.Second | cron.Minute | cron.Hour | cr
1616
funcscriptResource()*schema.Resource {
1717
return&schema.Resource{
1818
Description:"Use this resource to run a script from an agent.",
19-
CreateContext:func(ctx context.Context,rd*schema.ResourceData,iinterface{}) diag.Diagnostics {
19+
CreateContext:func(_ context.Context,rd*schema.ResourceData,_interface{}) diag.Diagnostics {
2020
rd.SetId(uuid.NewString())
2121
runOnStart,_:=rd.Get("run_on_start").(bool)
2222
runOnStop,_:=rd.Get("run_on_stop").(bool)
@@ -60,14 +60,14 @@ func scriptResource() *schema.Resource {
6060
ForceNew:true,
6161
Type:schema.TypeString,
6262
Required:true,
63-
Description:"The scriptto run.",
63+
Description:"Thecontent of thescriptthat will be run.",
6464
},
6565
"cron": {
6666
ForceNew:true,
6767
Type:schema.TypeString,
6868
Optional:true,
6969
Description:"The cron schedule to run the script on. This is a cron expression.",
70-
ValidateFunc:func(iinterface{},sstring) ([]string, []error) {
70+
ValidateFunc:func(iinterface{},_string) ([]string, []error) {
7171
v,ok:=i.(string)
7272
if!ok {
7373
return []string{}, []error{fmt.Errorf("got type %T instead of string",i)}
@@ -84,28 +84,28 @@ func scriptResource() *schema.Resource {
8484
Default:false,
8585
ForceNew:true,
8686
Optional:true,
87-
Description:"This optiondefines whetheror not the user can (by default) login to the workspacebeforethis scriptcompletes running on start. Whenenabled, users maysee an incomplete workspace when logging in.",
87+
Description:"This optiondetermines whetherusers can log in immediately or must wait for the workspaceto finish runningthis scriptupon startup. If notenabled, users mayencounter an incomplete workspace when logging in. This option only sets the default, the user can still manually override the behavior.",
8888
},
8989
"run_on_start": {
9090
Type:schema.TypeBool,
9191
Default:false,
9292
ForceNew:true,
9393
Optional:true,
94-
Description:"This option defines whether or not the script should run when the agent starts.",
94+
Description:"This option defines whether or not the script should run when the agent starts. The script should exit when it is done to signal that the agent is ready.",
9595
},
9696
"run_on_stop": {
9797
Type:schema.TypeBool,
9898
Default:false,
9999
ForceNew:true,
100100
Optional:true,
101-
Description:"This option defines whether or not the script should run when the agent stops.",
101+
Description:"This option defines whether or not the script should run when the agent stops. The script should exit when it is done to signal that the workspace can be stopped.",
102102
},
103103
"timeout": {
104104
Type:schema.TypeInt,
105105
Default:0,
106106
ForceNew:true,
107107
Optional:true,
108-
Description:"Time in secondsuntil the agent lifecycle status is marked as timed out, this happens when the script has not completed (exited) in the given time.",
108+
Description:"Time in secondsthat thescript is allowed to run. If the script does not complete within this time, the script is terminated and theagent lifecycle status is marked as timed out. A value of zero (default) means no timeout.",
109109
ValidateFunc:validation.IntAtLeast(1),
110110
},
111111
},

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp