Conversation
aviatco
force-pushed
the
dev/aviatcohen/deploy-command-docs
branch
from
474325d to
294cded
Compare
|
|
||
| **Parameters:** | ||
|
|
||
| - `--config <file>`: Path to the deployment configuration file. **Required**. |
There was a problem hiding this comment.
Path to the deployment configuration YAML file
| By default, **both publish and unpublish operations are enabled and executed**. | ||
| To disable either operation for a specific environment, it must be explicitly skipped in the configuration file. | ||
|
|
||
| The deployment to Fabric workspaces is executed via the Fabric REST APIs. |
There was a problem hiding this comment.
The deployment to the Fabric workspace....
| - The configuration file controls what is published and unpublished. | ||
| - Publish and unpublish operations are enabled by default. | ||
| - Skipping publish or unpublish must be explicitly defined per environment. | ||
| - Environment selection is resolved only when environment mappings are present in the configuration. |
There was a problem hiding this comment.
Target environment selection....
|
|
||
| ``` | ||
| fab deploy --config config.yml -tenv prod -P config_override='{"publish": {"items_to_include": ["MainNotebook.Notebook", "ProductionPipeline.DataPipeline"]}}' | ||
| ``` |
There was a problem hiding this comment.
What about the feature flags?
|
|
||
| ``` | ||
| fab deploy --config config.yml -tenv dev -P config_override='{"publish": {"folders_to_include": ["/Production/", "/Core/"]}}' | ||
| ``` |
There was a problem hiding this comment.
Can remove trailing / from each folder path
|
|
||
| ``` | ||
| fab deploy --config config.yml -tenv dev -P config_override='{"publish": {"folders_to_include": ["/Production/", "/Core/"]}}' | ||
| ``` |
There was a problem hiding this comment.
What about the feature flags?
|
|
||
| ``` | ||
| fab deploy --config config.yml -tenv prod -P config_override='{"publish": {"folder_exclude_regex": "^/temp/|^/debug/"}}' | ||
| ``` |
There was a problem hiding this comment.
remove trailing / from path
What about required feature flags?
|
|
||
| ### Usfull links | ||
|
|
||
| - [Fabric cicd lib](https://microsoft.github.io/fabric-cicd/latest/) No newline at end of file |
There was a problem hiding this comment.
Consider also directly linking the docs on configuration deployment
There was a problem hiding this comment.
i am wondering whether we should duplicate the docs from cicd in here instead of pointing to the cicd docs directly for parameterization and configuration explanations. @shirasassoon @aviatco wdyt?
on one hand, your approach keeps the users in cli context, no need to navigate and switch between docs.
on the other hand, we adds some level of maintanance.
There was a problem hiding this comment.
remove this file and apply 'skip-changelog' instead. no need of changelog in this case.
| By default, **both publish and unpublish operations are enabled and executed**. | ||
| To disable either operation for a specific environment, it must be explicitly skipped in the configuration file. | ||
|
|
||
| The deployment to Fabric workspaces is executed via the Fabric REST APIs. |
There was a problem hiding this comment.
i think this sentence is redundant
|
|
||
| ## Advanced Usage | ||
|
|
||
| ### Deployment Behavior |
There was a problem hiding this comment.
this section should not be under advanced usage, as it provides additional information about the command functionality.
| If the workspace is connected to Git, clone the repository locally: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/org/fabric-workspace.git |
There was a problem hiding this comment.
| git clone https://github.com/org/fabric-workspace.git | |
| git clone <git-repository-url>.git |
|
|
||
| ### Additional Notes | ||
|
|
||
| - The deploy command can be applied to Fabric item files created via Git integration or the Get Item Definition API (export command). |
There was a problem hiding this comment.
i'd switch
| - The deploy command can be applied to Fabric item files created via Git integration or the Get Item Definition API (export command). | |
| - The deploy command can be applied to Fabric item files created via Git integration or using the `export` command (utilizes Get Item Definition API). |
| ### Related Commands | ||
|
|
||
| - `export` — Export a single item from a workspace | ||
| - `import` — Import a single item from a workspace |
| | [`start`](./fs/start.md) | Start a resource | | ||
| | [`stop`](./fs/stop.md) | Stop a resource | | ||
| | [`unassign`](./fs/unassign.md) | Unassign a resource from a workspace | | ||
| | [`deploy`](./fs/deploy.md) | Deploy Fabric workspace items from local source content into a target Microsoft Fabric workspace. | |
There was a problem hiding this comment.
please update the mkdocs.yml to include this new command in the left navigation pane
3 participants
📥 Pull Request
✨ Description of new changes
This PR add documentation and examples for the new
deploycommand which imports workspace items from a local source into a target Fabric workspace.