This article provides answers to common questions about using the Visual Studio Code (VS Code) Extension for Assette. The extension is designed to streamline the process of editing and managing Blocks within Assette directly from the VS Code environment.
What is the purpose of the Assette VS Code Extension? #
The Assette VS Code Extension enables users to seamlessly access, edit, and upload Blocks from within Visual Studio Code. This provides a developer-friendly environment with enhanced tooling for making content or logic changes, while preserving the integrity of version management in Assette.
How does versioning behave when uploading Data Blocks? #
1. Uploading a Block with both a Published and Draft version #
- If the user attempts to upload changes to a Block that already has both a Published and Draft version, the extension will not create a new version.
- This behavior is intentional and has been in place since the initial release.
- The rationale is to prevent overwriting or creating unnecessary versions when a Draft already exists, which the user can continue editing through Assette’s platform or via VS Code.
2. Uploading a Block with only a Published version (no Draft) #
- If the Block has only a Published version (i.e., no active Draft exists), the upload operation from VS Code will create a new version.
- This facilitates a new Draft version to be created, allowing users to initiate modifications that are tracked and managed as a new version within Assette.
Can the extension be used to publish a Block? #
No, the VS Code Extension is intended for drafting and versioned editing purposes. Publishing a Block must still be performed within the Assette platform to ensure consistency with governance and approval workflows.
Are there any limitations users should be aware of? #
- Version Creation is Conditional: As explained above, version creation depends on the existence of an active Draft.
- Manual Publishing Required: The extension does not support publishing actions.
- Assette Account Required: Users must have proper authentication and permissions set up in Assette to use the extension.