Skip to content

feat: Enforce Helm dispatch only on main/release builds by default #154

@gandalf-at-lerian

Description

@gandalf-at-lerian

Request Type

New input / parameter for an existing workflow

Affected Workflow

Infrastructure (build, dispatch-helm)

Problem / Motivation

The plugin-br-pix-indirect-btg pipeline is opening PRs in the Helm repo (LerianStudio/helm) when RC tags are built (PR #1135). This is because the BTG build workflow explicitly sets helm_dispatch_on_rc: true.

The shared build.yml workflow already has boolean inputs to control this:

  • helm_dispatch_on_rc (default: false)
  • helm_dispatch_on_beta (default: false)

So the mechanism exists, but repos can opt-in to RC/beta dispatch. The desired behavior is: Helm chart dispatch should only happen on production (main) builds by default, and the BTG plugin repo needs to be updated to remove helm_dispatch_on_rc: true.

Proposed Solution

  1. Immediate fix: Remove helm_dispatch_on_rc: true from plugin-br-pix-indirect-btg/.github/workflows/build.yml so it uses the default (false).
  2. Audit: Review all repos that call the shared build workflow and verify which ones have helm_dispatch_on_rc or helm_dispatch_on_beta set to true — ensure it's intentional.
  3. Documentation: Add a note in the workflow docs making it clear that Helm dispatch should generally only target production releases (main), unless there's a specific reason for RC/beta dispatch.

Existing Boolean Inputs (reference)

# In build.yml (shared workflow)
helm_dispatch_on_rc:
  description: 'Enable Helm dispatch for release-candidate (rc) tags'
  type: boolean
  default: false
helm_dispatch_on_beta:
  description: 'Enable Helm dispatch for beta tags'
  type: boolean
  default: false

Current BTG config (needs fix)

# plugin-br-pix-indirect-btg/.github/workflows/build.yml
enable_helm_dispatch: true
helm_dispatch_on_rc: true  # <-- this should be removed/set to false

Example Usage

# Correct: only dispatch on production release tags
enable_helm_dispatch: true
# helm_dispatch_on_rc and helm_dispatch_on_beta default to false — no Helm PRs for pre-release builds

Would This Be a Breaking Change?

No — fully backward compatible

Additional Context

Discussed in #devops-team thread by Guilherme, Bruno, and Bedatty.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions