Closes #757 Support Selective Folder Deployment with List

[shirasassoon]

Closes #757

This pull request introduces support for selective folder deployment using an inclusion list, along with comprehensive documentation updates to clarify configuration options, feature flag usage, and troubleshooting guidance. The changes enhance deployment flexibility and improve the clarity and usability of the configuration-based deployment process.

Selective Deployment Features:

• Added support for specifying folders to include in deployments via the new folder_path_to_include setting in the configuration file, allowing users to deploy only targeted folders. [1] [2] [3] [4] [5]
• Updated documentation to detail mutual exclusivity between folder_exclude_regex and folder_path_to_include, provide configuration examples, and explain environment mapping for these options. [1] [2] [3]

Feature Flags and Configuration Options:

• Documented new and existing feature flags required for selective deployment, including enable_include_folder and enable_shortcut_exclude, and clarified their use in both publishing and unpublishing operations. [1] [2]
• Improved descriptions for optional fields and their behavior when omitted or when environment mappings are missing, including logging and default behaviors. [1] [2]

General Documentation Improvements:

• Enhanced clarity and consistency throughout the configuration and troubleshooting documentation, including better formatting, updated warnings, and more precise descriptions of required and optional fields. [1] [2] [3] [4] [5] [6] [7]

Examples and Logging:

• Provided updated configuration and logging examples to illustrate new folder inclusion features, environment mapping, and expected debug/warning messages. [1] [2] [3]

Troubleshooting and Validation:

• Expanded troubleshooting guidance to cover common configuration errors, especially those related to selective folder deployment and environment mapping.

Let me know if you’d like a walkthrough of how to use the new selective folder deployment feature or how to set the relevant feature flags!

[Copilot]

Pull request overview

Adds an experimental capability to selectively publish workspace content by including only specific folder paths (in addition to existing folder exclusion), integrating this into the publish API, config-based deployments, validation, tests, docs, and changelog.

Changes:

• Introduces enable_include_folder feature flag and folder_path_to_include publish setting/parameter.
• Updates publish workflow and workspace folder/item publishing logic to respect inclusion/exclusion controls.
• Extends config validation/utilities, docs, sample config, and tests to cover the new setting.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
src/fabric_cicd/constants.py	Adds ENABLE_INCLUDE_FOLDER and config schema/settings support for folder_path_to_include.
src/fabric_cicd/_common/_validate_input.py	Adds a new validation entry point for folder_path_to_include gated by feature flags.
src/fabric_cicd/publish.py	Extends publish_all_items and config-driven deployment to accept/apply folder_path_to_include.
src/fabric_cicd/fabric_workspace.py	Implements inclusion/exclusion checks in folder and item publishing paths.
src/fabric_cicd/_common/_config_validator.py	Adds config validation for publish.folder_path_to_include and related error messages.
src/fabric_cicd/_common/_config_utils.py	Ensures folder_path_to_include is extracted from config for publish operations.
tests/test_publish.py	Updates folder-exclude regex expectations and adds a direct publish inclusion test.
tests/test_deploy_with_config.py	Adds config extraction/passing tests for folder_path_to_include and adjusts regex examples.
tests/test_config_validator.py	Adds validator test coverage for folder_path_to_include and updates expected field counts/messages.
docs/how_to/optional_feature.md	Documents the new enable_include_folder flag.
docs/how_to/config_deployment.md	Documents the new publish setting and clarifies folder path formatting expectations.
sample/workspace/config.yml	Shows commented examples for folder_exclude_regex and folder_path_to_include.
.changes/unreleased/added-20260210-151850.yaml	Changelog entry for selective folder deployment via inclusion list.