feat: split stack property into per-builder properties

The `stack` property lived on the `buildpacks` plugin but was shared by both the herokuish and pack builders, so a value valid for one builder broke the other. Each builder now owns its own `stack` property managed via `builder-herokuish:set` and `builder-pack:set`, while `buildpacks:set-property stack` is deprecated and forwards the value to the builder detected from it; existing values migrate automatically on upgrade and changing a builder's stack clears that builder's cache.
This commit is contained in:
Jose Diaz-Gonzalez committed 2026-11-02 16:48:11 -05:00
1 parent 5ef061d3d2
commit 59594937f9
23 files changed
+449 -178

No files matched your search

+3 -1
View File
@@ -2,6 +2,7 @@
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$PLUGIN_AVAILABLE_PATH/builder-herokuish/internal-functions"
source "$PLUGIN_AVAILABLE_PATH/config/functions"
fn-builder-herokuish-ensure-cache() {
@@ -23,7 +24,8 @@ trigger-builder-herokuish-builder-build() {
return
fi
local stack="$(plugn trigger buildpack-stack-name "$APP")"
local stack="$(fn-builder-herokuish-stack "$APP")"
[[ -z "$stack" ]] && stack="$(fn-builder-herokuish-global-stack "$APP")"
if [[ -n "$stack" ]]; then
dokku_log_info1 "Building $APP from $stack"
DOKKU_IMAGE="$stack"
@@ -28,3 +28,27 @@ fn-builder-herokuish-allowed() {
fn-plugin-property-get-default "builder-herokuish" "$APP" "allowed" ""
}
fn-builder-herokuish-computed-stack() {
declare APP="$1"
stack="$(fn-builder-herokuish-stack "$APP")"
if [[ -z "$stack" ]]; then
stack="$(fn-builder-herokuish-global-stack "$APP")"
fi
if [[ -z "$stack" ]]; then
stack="${DOKKU_IMAGE:-gliderlabs/herokuish:latest-24}"
fi
echo "$stack"
}
fn-builder-herokuish-global-stack() {
fn-plugin-property-get-default "builder-herokuish" "--global" "stack" ""
}
fn-builder-herokuish-stack() {
declare APP="$1"
fn-plugin-property-get-default "builder-herokuish" "$APP" "stack" ""
}
+30
View File
@@ -1,6 +1,8 @@
package builderherokuish
import (
"os"
"github.com/dokku/dokku/plugins/common"
)
@@ -17,12 +19,17 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
flags = map[string]common.ReportFunc{
"--builder-herokuish-computed-allowed": reportComputedAllowed,
"--builder-herokuish-global-allowed": reportGlobalAllowed,
"--builder-herokuish-computed-stack": reportComputedStack,
"--builder-herokuish-global-stack": reportGlobalStack,
}
} else {
flags = map[string]common.ReportFunc{
"--builder-herokuish-computed-allowed": reportComputedAllowed,
"--builder-herokuish-global-allowed": reportGlobalAllowed,
"--builder-herokuish-allowed": reportAllowed,
"--builder-herokuish-computed-stack": reportComputedStack,
"--builder-herokuish-global-stack": reportGlobalStack,
"--builder-herokuish-stack": reportStack,
}
}
@@ -68,6 +75,29 @@ func reportComputedAllowed(appName string) string {
return allowed
}
func reportStack(appName string) string {
return common.PropertyGet("builder-herokuish", appName, "stack")
}
func reportGlobalStack(appName string) string {
return common.PropertyGet("builder-herokuish", "--global", "stack")
}
func reportComputedStack(appName string) string {
stack := reportStack(appName)
if stack == "" {
stack = reportGlobalStack(appName)
}
if stack == "" {
stack = os.Getenv("DOKKU_IMAGE")
}
if stack == "" {
stack = "gliderlabs/herokuish:latest-24"
}
return stack
}
// hostArchitecture returns the dpkg architecture of the host, or an empty string
// when it cannot be determined (matching the bash `dpkg --print-architecture` check)
func hostArchitecture() string {
+10 -2
View File
@@ -9,13 +9,13 @@ cmd-builder-herokuish-set() {
declare cmd="builder-herokuish:set"
[[ "$1" == "$cmd" ]] && shift 1
declare APP="$1" KEY="$2" VALUE="$3"
local VALID_KEYS=("allowed")
local VALID_KEYS=("allowed" "stack")
[[ "$APP" == "--global" ]] || verify_app_name "$APP"
[[ -z "$KEY" ]] && dokku_log_fail "No key specified"
if ! fn-in-array "$KEY" "${VALID_KEYS[@]}"; then
dokku_log_fail "Invalid key specified, valid keys include: allowed"
dokku_log_fail "Invalid key specified, valid keys include: allowed, stack"
fi
if [[ -n "$VALUE" ]]; then
@@ -25,6 +25,14 @@ cmd-builder-herokuish-set() {
dokku_log_info2_quiet "Unsetting ${KEY}"
fn-plugin-property-delete "builder-herokuish" "$APP" "$KEY"
fi
if [[ "$KEY" == "stack" ]]; then
if [[ "$APP" == "--global" ]]; then
for app in $(dokku_apps 2>/dev/null || true); do plugn trigger post-stack-set "$app" "$VALUE"; done
else
plugn trigger post-stack-set "$APP" "$VALUE"
fi
fi
}
cmd-builder-herokuish-set "$@"
+7 -1
View File
@@ -1,5 +1,6 @@
#!/usr/bin/env bash
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
source "$PLUGIN_AVAILABLE_PATH/builder-pack/internal-functions"
source "$PLUGIN_AVAILABLE_PATH/config/functions"
set -eo pipefail
[[ $DOKKU_TRACE ]] && set -x
@@ -13,7 +14,8 @@ trigger-builder-pack-builder-build() {
return
fi
local stack="$(plugn trigger buildpack-stack-name "$APP")"
local stack="$(fn-builder-pack-stack "$APP")"
[[ -z "$stack" ]] && stack="$(fn-builder-pack-global-stack "$APP")"
if [[ -n "$stack" ]]; then
DOKKU_CNB_BUILDER="$stack"
fi
@@ -303,6 +305,10 @@ trigger-builder-pack-builder-build() {
local DOCKER_CONFIG
DOCKER_CONFIG="$(fn-registry-docker-config-dir "$APP")"
[[ -n "$DOCKER_CONFIG" ]] && export DOCKER_CONFIG
if [[ "$(fn-plugin-property-get-default "builder-pack" "$APP" "clear-cache" "false")" == "true" ]]; then
fn-in-array "--clear-cache" "${PACK_ARGS[@]}" || PACK_ARGS+=("--clear-cache")
fn-plugin-property-delete "builder-pack" "$APP" "clear-cache"
fi
pack build "$IMAGE" --builder "$DOKKU_CNB_BUILDER" --path "$SOURCECODE_WORK_DIR" --default-process web "${PACK_ARGS[@]}" "${ENV_ARGS[@]}"
docker-image-labeler relabel --label=dokku --label=org.label-schema.schema-version=1.0 --label=org.label-schema.vendor=dokku --label=com.dokku.image-stage=build --label=com.dokku.builder-type=pack --label=com.dokku.app-name=$APP "$IMAGE"
+26
View File
@@ -29,3 +29,29 @@ fn-builder-pack-projecttoml-path() {
fn-plugin-property-get-default "builder-pack" "$APP" "projecttoml-path" ""
}
fn-builder-pack-computed-stack() {
declare APP="$1"
stack="$(fn-builder-pack-stack "$APP")"
if [[ "$stack" == "" ]]; then
stack="$(fn-builder-pack-global-stack "$APP")"
fi
if [[ "$stack" == "" ]]; then
stack="${DOKKU_CNB_BUILDER:-heroku/builder:24}"
fi
echo "$stack"
}
fn-builder-pack-global-stack() {
declare APP="$1"
fn-plugin-property-get-default "builder-pack" "--global" "stack" ""
}
fn-builder-pack-stack() {
declare APP="$1"
fn-plugin-property-get-default "builder-pack" "$APP" "stack" ""
}
+30
View File
@@ -1,6 +1,8 @@
package builderpack
import (
"os"
"github.com/dokku/dokku/plugins/common"
)
@@ -17,12 +19,17 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
flags = map[string]common.ReportFunc{
"--builder-pack-computed-projecttoml-path": reportComputedProjecttomlPath,
"--builder-pack-global-projecttoml-path": reportGlobalProjecttomlPath,
"--builder-pack-computed-stack": reportComputedStack,
"--builder-pack-global-stack": reportGlobalStack,
}
} else {
flags = map[string]common.ReportFunc{
"--builder-pack-computed-projecttoml-path": reportComputedProjecttomlPath,
"--builder-pack-global-projecttoml-path": reportGlobalProjecttomlPath,
"--builder-pack-projecttoml-path": reportProjecttomlPath,
"--builder-pack-computed-stack": reportComputedStack,
"--builder-pack-global-stack": reportGlobalStack,
"--builder-pack-stack": reportStack,
}
}
@@ -64,3 +71,26 @@ func reportComputedProjecttomlPath(appName string) string {
return value
}
func reportStack(appName string) string {
return common.PropertyGet("builder-pack", appName, "stack")
}
func reportGlobalStack(appName string) string {
return common.PropertyGet("builder-pack", "--global", "stack")
}
func reportComputedStack(appName string) string {
value := reportStack(appName)
if value == "" {
value = reportGlobalStack(appName)
}
if value == "" {
value = os.Getenv("DOKKU_CNB_BUILDER")
}
if value == "" {
value = "heroku/builder:24"
}
return value
}
+10 -2
View File
@@ -9,13 +9,13 @@ cmd-builder-pack-set() {
declare cmd="builder-pack:set"
[[ "$1" == "$cmd" ]] && shift 1
declare APP="$1" KEY="$2" VALUE="$3"
local VALID_KEYS=("projecttoml-path")
local VALID_KEYS=("projecttoml-path" "stack")
[[ "$APP" == "--global" ]] || verify_app_name "$APP"
[[ -z "$KEY" ]] && dokku_log_fail "No key specified"
if ! fn-in-array "$KEY" "${VALID_KEYS[@]}"; then
dokku_log_fail "Invalid key specified, valid keys include: projecttoml-path"
dokku_log_fail "Invalid key specified, valid keys include: projecttoml-path, stack"
fi
if [[ -n "$VALUE" ]]; then
@@ -25,6 +25,14 @@ cmd-builder-pack-set() {
dokku_log_info2_quiet "Unsetting ${KEY}"
fn-plugin-property-delete "builder-pack" "$APP" "$KEY"
fi
if [[ "$KEY" == "stack" ]]; then
if [[ "$APP" == "--global" ]]; then
for app in $(dokku_apps 2>/dev/null || true); do fn-plugin-property-write "builder-pack" "$app" "clear-cache" "true"; done
else
fn-plugin-property-write "builder-pack" "$APP" "clear-cache" "true"
fi
fi
}
cmd-builder-pack-set "$@"
-1
View File
@@ -2,7 +2,6 @@
/subcommands/*
/triggers/*
/triggers
/buildpack-stack-name
/install
/post-*
/report
+1 -1
View File
@@ -1,5 +1,5 @@
SUBCOMMANDS = subcommands/add subcommands/clear subcommands/detect subcommands/list subcommands/remove subcommands/report subcommands/set subcommands/set-property
TRIGGERS = triggers/buildpack-stack-name triggers/install triggers/post-app-clone-setup triggers/post-app-rename-setup triggers/post-delete triggers/post-extract triggers/report
TRIGGERS = triggers/install triggers/post-app-clone-setup triggers/post-app-rename-setup triggers/post-delete triggers/post-extract triggers/report
BUILD = commands subcommands triggers
PLUGIN_NAME = buildpacks
+17 -6
View File
@@ -1,13 +1,24 @@
package buildpacks
import "strings"
var (
// DefaultProperties is a map of all valid buildpacks properties with corresponding default property values
DefaultProperties = map[string]string{
"stack": "",
}
DefaultProperties = map[string]string{}
// GlobalProperties is a map of all valid global buildpacks properties
GlobalProperties = map[string]bool{
"stack": true,
}
GlobalProperties = map[string]bool{}
)
// isHerokuishStack reports whether a stack value targets the herokuish builder
func isHerokuishStack(value string) bool {
return strings.Contains(value, "herokuish")
}
// builderForStack returns the builder plugin name a stack value should be written to
func builderForStack(value string) string {
if isHerokuishStack(value) {
return "builder-herokuish"
}
return "builder-pack"
}
+2 -37
View File
@@ -1,7 +1,6 @@
package buildpacks
import (
"os"
"strings"
"github.com/dokku/dokku/plugins/common"
@@ -17,15 +16,10 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
var flags map[string]common.ReportFunc
if appName == "--global" {
flags = map[string]common.ReportFunc{
"--buildpacks-global-stack": reportGlobalStack,
}
flags = map[string]common.ReportFunc{}
} else {
flags = map[string]common.ReportFunc{
"--buildpacks-computed-stack": reportComputedStack,
"--buildpacks-global-stack": reportGlobalStack,
"--buildpacks-list": reportList,
"--buildpacks-stack": reportStack,
"--buildpacks-list": reportList,
}
}
@@ -48,31 +42,6 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
})
}
func reportComputedStack(appName string) string {
if stack := common.PropertyGetDefault("buildpacks", appName, "stack", ""); stack != "" {
return stack
}
if stack := common.PropertyGetDefault("buildpacks", "--global", "stack", ""); stack != "" {
return stack
}
results, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{
Trigger: "config-get",
Args: []string{appName, "DOKKU_IMAGE"},
})
if dokkuImage := results.StdoutContents(); dokkuImage != "" {
common.LogWarn("Deprecated: use buildpacks:set-property instead of specifying DOKKU_IMAGE environment variable")
return dokkuImage
}
return os.Getenv("DOKKU_IMAGE")
}
func reportGlobalStack(appName string) string {
return common.PropertyGetDefault("buildpacks", "--global", "stack", "")
}
func reportList(appName string) string {
buildpacks, err := common.PropertyListGet("buildpacks", appName, "buildpacks")
if err != nil {
@@ -81,7 +50,3 @@ func reportList(appName string) string {
return strings.Join(buildpacks, ",")
}
func reportStack(appName string) string {
return common.PropertyGetDefault("buildpacks", appName, "stack", "")
}
@@ -18,9 +18,6 @@ func main() {
var err error
switch trigger {
case "buildpack-stack-name":
appName := flag.Arg(0)
err = buildpacks.TriggerBuildpackStackName(appName)
case "install":
err = buildpacks.TriggerInstall()
case "post-app-clone-setup":
+47 -18
View File
@@ -215,35 +215,64 @@ func setBuildpackList(appName string, buildpacks []string, index int) error {
// CommandSetProperty implements buildpacks:set-property
func CommandSetProperty(appName string, property string, value string) error {
oldStack := ""
if property == "stack" {
oldStack = common.PropertyGet("buildpacks", appName, "stack")
if property != "stack" {
common.CommandPropertySet("buildpacks", appName, property, value, DefaultProperties, GlobalProperties)
return nil
}
common.CommandPropertySet("buildpacks", appName, property, value, DefaultProperties, GlobalProperties)
if property == "stack" && oldStack != value {
if appName != "--global" {
_, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
Trigger: "post-stack-set",
Args: []string{appName, value},
StreamStdio: true,
})
if value != "" {
builder := builderForStack(value)
common.LogWarn(fmt.Sprintf("Deprecated: buildpacks:set-property stack is deprecated, use %s:set stack instead", builder))
if err := common.PropertyWrite(builder, appName, "stack", value); err != nil {
return err
}
return clearBuilderCache(builder, appName)
}
apps, err := common.DokkuApps()
if err != nil && !errors.Is(err, common.NoAppsExist) {
common.LogWarn("Deprecated: buildpacks:set-property stack is deprecated, use builder-herokuish:set stack or builder-pack:set stack instead")
for _, builder := range []string{"builder-herokuish", "builder-pack"} {
if err := common.PropertyDelete(builder, appName, "stack"); err != nil {
return err
}
for _, app := range apps {
_, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
if err := clearBuilderCache(builder, appName); err != nil {
return err
}
}
return nil
}
// clearBuilderCache clears the build cache for the given builder after a stack
// change. The herokuish cache is the cache-$APP volume removed by repo via the
// post-stack-set trigger, while the pack cache lives in pack-managed volumes and
// is cleared by flagging the next build to run with --clear-cache.
func clearBuilderCache(builder string, appName string) error {
apps := []string{appName}
if appName == "--global" {
dokkuApps, err := common.DokkuApps()
if err != nil {
if errors.Is(err, common.NoAppsExist) {
return nil
}
return err
}
apps = dokkuApps
}
for _, app := range apps {
if builder == "builder-herokuish" {
if _, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
Trigger: "post-stack-set",
Args: []string{app, value},
Args: []string{app, ""},
StreamStdio: true,
})
if err != nil {
}); err != nil {
return err
}
continue
}
if err := common.PropertyWrite("builder-pack", app, "clear-cache", "true"); err != nil {
return err
}
}
+35 -26
View File
@@ -2,6 +2,7 @@ package buildpacks
import (
"bufio"
"errors"
"fmt"
"os"
"path/filepath"
@@ -9,38 +10,46 @@ import (
"github.com/dokku/dokku/plugins/common"
)
// TriggerBuildpackStackName echos the stack name for the app
func TriggerBuildpackStackName(appName string) error {
if stack := common.PropertyGetDefault("buildpacks", appName, "stack", ""); stack != "" {
fmt.Println(stack)
return nil
}
if stack := common.PropertyGetDefault("buildpacks", "--global", "stack", ""); stack != "" {
fmt.Println(stack)
return nil
}
results, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{
Trigger: "config-get",
Args: []string{appName, "DOKKU_IMAGE"},
})
dokkuImage := results.StdoutContents()
if dokkuImage != "" {
common.LogWarn("Deprecated: use buildpacks:set-property instead of specifying DOKKU_IMAGE environment variable")
fmt.Println(dokkuImage)
return nil
}
return nil
}
// TriggerInstall runs the install step for the buildpacks plugin
func TriggerInstall() error {
if err := common.PropertySetup("buildpacks"); err != nil {
return fmt.Errorf("Unable to install the buildpacks plugin: %s", err.Error())
}
return migrateStackProperty()
}
// migrateStackProperty moves any legacy buildpacks stack values to the
// appropriate builder plugin, detecting herokuish vs pack stacks. It is
// idempotent: once a value is migrated the buildpacks stack key is removed.
func migrateStackProperty() error {
appNames := []string{"--global"}
apps, err := common.DokkuApps()
if err != nil && !errors.Is(err, common.NoAppsExist) {
return err
}
appNames = append(appNames, apps...)
for _, appName := range appNames {
if !common.PropertyExists("buildpacks", appName, "stack") {
continue
}
value := common.PropertyGet("buildpacks", appName, "stack")
if value != "" {
builder := builderForStack(value)
if !common.PropertyExists(builder, appName, "stack") {
if err := common.PropertyWrite(builder, appName, "stack", value); err != nil {
return err
}
}
}
if err := common.PropertyDelete("buildpacks", appName, "stack"); err != nil {
return err
}
}
return nil
}