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

refactor: rename command to :set-property

Browse Source 
This will allow us to set other property values for the buildpacks plugin.
This commit is contained in:
Jose Diaz-Gonzalez
2021-01-23 18:17:40 -05:00
parent 5d9157bc40
commit f81c802ecc
9 changed files with 42 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/deployment/methods/cloud-native-buildpacks.md
View File

@@ -3,7 +3,7 @@
> New as of 0.22.0
```
buildpacks:stack-set <app> <stack> # Sets the stack of an app
buildpacks:set-property [--global|<app>] <key> <value> # Set or clear a buildpacks property for an app
```
Cloud Native Buildpacks are an evolution over the Buildpacks technology provided by the Herokuish builder. See the [herokuish buildpacks documentation](/docs/deployment/methods/herokuish.md) for more information on how to clear buildpack build cache for an application.
@@ -39,16 +39,16 @@ As this functionality is highly experimental, there are a number of caveats. Ple
> New as of 0.23.0
The default stack builder in use by CNB buildpacks in Dokku is based on `heroku/buildpacks`. Users may desire to switch the stack builder to a custom version, either to update the operating system or to customize packages included with the stack builder. This can be performed via the `buildpacks:stack-set` command.
The default stack builder in use by CNB buildpacks in Dokku is based on `heroku/buildpacks`. Users may desire to switch the stack builder to a custom version, either to update the operating system or to customize packages included with the stack builder. This can be performed via the `buildpacks:set-property` command.
```shell
dokku buildpacks:stack-set node-js-app paketobuildpacks/build:base-cnb
dokku buildpacks:set-property node-js-app paketobuildpacks/build:base-cnb
```
The specified stack builder can also be unset by omitting the name of the stack builder when calling `buildpacks:stack-set`.
The specified stack builder can also be unset by omitting the name of the stack builder when calling `buildpacks:set-property`.
```shell
dokku buildpacks:stack-set node-js-app
dokku buildpacks:set-property node-js-app
```
A change in the stack builder value will execute the `post-stack-set` trigger.
@@ -57,8 +57,8 @@ Finally, stack builders can be set or unset globally as a fallback. This will ta
```shell
# set globally
dokku buildpacks:stack-set --global paketobuildpacks/build:base-cnb
dokku buildpacks:set-property --global paketobuildpacks/build:base-cnb
# unset globally
dokku buildpacks:stack-set --global
dokku buildpacks:set-property --global
```

26
docs/deployment/methods/herokuish-buildpacks.md
View File

@@ -3,13 +3,13 @@
> Subcommands new as of 0.15.0
```
buildpacks:add [--index 1] <app> <buildpack> # Add new app buildpack while inserting into list of buildpacks if necessary
buildpacks:clear <app> # Clear all buildpacks set on the app
buildpacks:list <app> # List all buildpacks for an app
buildpacks:remove <app> <buildpack> # Remove a buildpack set on the app
buildpacks:report [<app>] [<flag>] # Displays a buildpack report for one or more apps
buildpacks:set [--index 1] <app> <buildpack> # Set new app buildpack at a given position defaulting to the first buildpack if no index is specified
buildpacks:stack-set <app> <stack> # Sets the stack of an app
buildpacks:add [--index 1] <app> <buildpack> # Add new app buildpack while inserting into list of buildpacks if necessary
buildpacks:clear <app> # Clear all buildpacks set on the app
buildpacks:list <app> # List all buildpacks for an app
buildpacks:remove <app> <buildpack> # Remove a buildpack set on the app
buildpacks:report [<app>] [<flag>] # Displays a buildpack report for one or more apps
buildpacks:set [--index 1] <app> <buildpack> # Set new app buildpack at a given position defaulting to the first buildpack if no index is specified
buildpacks:set-property [--global|<app>] <key> <value> # Set or clear a buildpacks property for an app
```
> Warning: If using the `buildpacks` plugin, be sure to unset any `BUILDPACK_URL` and remove any such entries from a committed `.env` file. A specified `BUILDPACK_URL` will always override a `.buildpacks` file or the buildpacks plugin.
@@ -128,16 +128,16 @@ dokku buildpacks:clear node-js-app
> New as of 0.23.0
The default stack builder in use by Herokuish buildpacks in Dokku is based on `gliderlabs/herokuish:latest`. Typically, this is installed via an OS package which pulls the requisite Docker image. Users may desire to switch the stack builder to a custom version, either to update the operating system or to customize packages included with the stack builder. This can be performed via the `buildpacks:stack-set` command.
The default stack builder in use by Herokuish buildpacks in Dokku is based on `gliderlabs/herokuish:latest`. Typically, this is installed via an OS package which pulls the requisite Docker image. Users may desire to switch the stack builder to a custom version, either to update the operating system or to customize packages included with the stack builder. This can be performed via the `buildpacks:set-property` command.
```shell
dokku buildpacks:stack-set node-js-app gliderlabs/herokuish:latest
dokku buildpacks:set-property node-js-app gliderlabs/herokuish:latest
```
The specified stack builder can also be unset by omitting the name of the stack builder when calling `buildpacks:stack-set`.
The specified stack builder can also be unset by omitting the name of the stack builder when calling `buildpacks:set-property`.
```shell
dokku buildpacks:stack-set node-js-app
dokku buildpacks:set-property node-js-app
```
A change in the stack builder value will execute the `post-stack-set` trigger.
@@ -146,10 +146,10 @@ Finally, stack builders can be set or unset globally as a fallback. This will ta
```shell
# set globally
dokku buildpacks:stack-set --global gliderlabs/herokuish:latest
dokku buildpacks:set-property --global gliderlabs/herokuish:latest
# unset globally
dokku buildpacks:stack-set --global
dokku buildpacks:set-property --global
```
### Displaying buildpack reports for an app