github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

chore: document that flag parsing should be stopped via --

Browse Source
This commit is contained in:
Jose Diaz-Gonzalez
2024-01-18 17:31:28 -05:00
parent ba714c189f
commit 997f04afae
2 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/processes/one-off-tasks.md
View File

@@ -20,8 +20,9 @@ The `run` command can be used to run a one-off process for a specific command. T
> New as of 0.25.0, this container will be removed after the process exits.
```shell
# runs `ls -lah` in the `/app` directory of the app `node-js-app`
dokku run node-js-app ls -lah
# runs `ls` in the `/app` directory of the app `node-js-app`
#
dokku run node-js-app ls
# optionally, run can be passed custom environment variables
dokku run --env "NODE_ENV=development" --env "PATH=/custom/path" node-js-app npm run mytask
@@ -29,6 +30,13 @@ dokku run --env "NODE_ENV=development" --env "PATH=/custom/path" node-js-app npm
One off containers are removed at the end of process execution.
If the custom command uses flags, it must be separated from the `dokku enter` command via `--` (double dashes):
```shell
# runs `ls -lah` in the `/app` directory of the app `node-js-app`
dokku run node-js-app -- ls -lah
```
#### Running Procfile commands
The `run` command can also be used to run a command defined in the app `Procfile`:
@@ -58,7 +66,7 @@ dokku --label=com.example.test-label=value run node-js-app ls -lah
One-off containers default to interactive mode where possible. To disable this behavior, specify the `--no-tty` flag:
```shell
dokku run --no-tty node-js-app ls -lah
dokku run --no-tty node-js-app -- ls -lah
```
### Running a detached container
@@ -69,7 +77,7 @@ dokku run --no-tty node-js-app ls -lah
Finally, a container can be run in "detached" mode via the `run:detached` Dokku command. Running a process in detached mode will immediately return a `CONTAINER_ID`. Detached containers are run without a tty and are also removed at the end of process execution.
```shell
dokku run:detached node-js-app ls -lah
dokku run:detached node-js-app -- ls -lah
# returns the ID of the new container
```

2
tests/unit/git_1.bats
View File

@@ -98,7 +98,7 @@ teardown() {
assert_output_contains "objects"
assert_output_contains "refs"
run /bin/bash -c "dokku enter $TEST_APP web test -d .git"
run /bin/bash -c "dokku enter $TEST_APP web -- test -d .git"
echo "output: $output"
echo "status: $status"
assert_success