Skip to content

Docs: GitHub workflow example uses invalid config key 'fab_encryption_fallback_enabled' #267

Description

@ltsyen

Summary

The published GitHub Actions example (docs/examples/files/github-workflow.yml, rendered at https://microsoft.github.io/fabric-cli/examples/files/github-workflow.yml) contains:

fab config set fab_encryption_fallback_enabled true

That key is rejected by the CLI. The correct user-facing key — per the config command docs and the source (fab_constant.py: FAB_ENCRYPTION_FALLBACK_ENABLED = "encryption_fallback_enabled") — is encryption_fallback_enabled, without the fab_ prefix. The example appears to use the Python constant's name instead of its value.

Repro

$ pip install ms-fabric-cli==1.6.1
$ fab config set fab_encryption_fallback_enabled true
x config set: [InvalidInput] 'fab_encryption_fallback_enabled' is not a recognized configuration key. Please check the available configuration keys
$ fab config set encryption_fallback_enabled true
* Configuration 'encryption_fallback_enabled' set to 'true'

Impact

The example is the canonical reference for running fab in CI with a service principal (where the encryption fallback is required because runners have no OS keyring), so anyone copying it gets a failing pipeline on the very first step. We hit this verbatim when setting up a deployment workflow.

Suggested fix

Change the line in docs/examples/files/github-workflow.yml to:

fab config set encryption_fallback_enabled true

Version: ms-fabric-cli 1.6.1

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions