Skip to content

Commit 8c87158

Browse files
committed
better help
1 parent 11f6cdb commit 8c87158

5 files changed

Lines changed: 32 additions & 12 deletions

File tree

local/etc/uceap.d/devcontainer_on_create.sh

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ function devcontainer_on_create() {
5454
fi
5555
}
5656

57-
_devcontainer_on_create_desc="Runs when the devcontainer is created"
58-
_devcontainer_on_create_help="
59-
"
57+
_devcontainer_on_create_desc='Runs when the devcontainer is created'
58+
_devcontainer_on_create_help='
59+
This command implements the `onCreateCommand` lifecycle event for dev containers.
60+
61+
This command is the first of three (along with `updateContentCommand` and `postCreateCommand`) that finalizes container setup when a dev container is created. It and subsequent commands execute **inside** the container immediately after it has started for the first time.
62+
63+
Cloud services can use this command when caching or prebuilding a container. This means that it will not typically have access to user-scoped assets or secrets.
64+
'

local/etc/uceap.d/devcontainer_post_create.sh

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ function devcontainer_post_create() {
3434
fi
3535
}
3636

37-
_devcontainer_post_create_desc="Runs after the devcontainer is created"
38-
_devcontainer_post_create_help="
39-
"
37+
_devcontainer_post_create_desc='Runs after the devcontainer is created'
38+
_devcontainer_post_create_help='
39+
This command implements the `postCreateCommand` lifecycle event for dev containers.
40+
41+
This is the last of three that finalizes container setup when a dev container is created. It happens after `updateContentCommand` and once the dev container has been assigned to a user for the first time.
42+
43+
Cloud services can use this command to take advantage of user specific secrets and permissions.
44+
'

local/etc/uceap.d/devcontainer_post_start.sh

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ function devcontainer_post_start() {
88
fi
99
}
1010

11-
_devcontainer_post_start_desc="Runs after the devcontainer is started"
12-
_devcontainer_post_start_help="
13-
"
11+
_devcontainer_post_start_desc='Runs after the devcontainer is started'
12+
_devcontainer_post_start_help='
13+
This command implements the `postStartCommand` lifecycle event for dev containers.
14+
15+
This is run each time the container is successfully started.
16+
'

local/etc/uceap.d/devcontainer_update_content.sh

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ function devcontainer_update_content() {
1616
fi
1717
}
1818

19-
_devcontainer_update_content_desc="Runs when the devcontainer needs to update content"
20-
_devcontainer_update_content_help="
21-
"
19+
_devcontainer_update_content_desc='Runs when the devcontainer needs to update content'
20+
_devcontainer_update_content_help='
21+
This command implements the `updateContentCommand` lifecycle event for dev containers.
22+
23+
This is the second of three that finalizes container setup when a dev container is created. It executes inside the container after `onCreateCommand` whenever new content is available in the source tree during the creation process.
24+
25+
It will execute at least once, but cloud services will also periodically execute the command to refresh cached or prebuilt containers. Like cloud services using `onCreateCommand`, it can only take advantage of repository and org scoped secrets or permissions.
26+
'

local/etc/uceap.d/help.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ function _help() {
2929
}
3030
_help_desc='Displays help for `uceap` commands'
3131
_help_help='
32+
Show help for UCEAP CLI commands.
33+
3234
# Usage
3335
3436
``` sh

0 commit comments

Comments
 (0)