Config workflow with sync packages

You're viewing version 8.1 of this page. View latest () documentation.

Using Site Studio to build website templates, components and styles produces configuration entities which can be exported and imported using Site Studio's package management tools. You will need to use a combination of the Site Studio Sync sub-module and the contrib modules Config Ignore and Config Split to effectively export and deploy Site Studio configuration alongside Drupal configuration.

Development workflow

The development workflow recommended when developing with Site Studio includes some important additional steps. The following section compares a standard Drupal development workflow with a development workflow that includes Site Studio.

Standard Drupal development workflow

Standard Drupal development workflow usually consists of 4 stages:

1. Development of a feature
2. Exporting configuration changes relevant to the developed feature
3. Committing exported configuration and any custom code relevant to the feature
4. Pushing the changes to remote repository and reviewing work

 

Development workflow including Site Studio

Config workflow with sync packages

You're viewing version 8.1 of this page. View latest () documentation.

Using Site Studio to build website templates, components and styles produces configuration entities which can be exported and imported using Site Studio's package management tools. You will need to use a combination of the Site Studio Sync sub-module and the contrib modules Config Ignore and Config Split to effectively export and deploy Site Studio configuration alongside Drupal configuration.

Development workflow

The development workflow recommended when developing with Site Studio includes some important additional steps. The following section compares a standard Drupal development workflow with a development workflow that includes Site Studio.

Standard Drupal development workflow

Standard Drupal development workflow usually consists of 4 stages:

1. Development of a feature
2. Exporting configuration changes relevant to the developed feature
3. Committing exported configuration and any custom code relevant to the feature
4. Pushing the changes to remote repository and reviewing work

 

Development workflow including Site Studio

Developing with Site Studio adds two steps to the process:

1. Development of a feature
2. Exporting configuration changes relevant to the developed feature
3. Exporting Site Studio packages
4. Committing exported configuration and any custom code relevant to the feature
5. Committing exported Site Studio packages
6. Pushing the changes to remote repository and reviewing work

The recommended approach as shown above, is to split your Site Studio sync packages from your Drupal config using Config ignore and Config split modules. For more information, see Setup Config Ignore and Config Split.

Developing with Site Studio adds two steps to the process:

1. Development of a feature
2. Exporting configuration changes relevant to the developed feature
3. Exporting Site Studio packages
4. Committing exported configuration and any custom code relevant to the feature
5. Committing exported Site Studio packages
6. Pushing the changes to remote repository and reviewing work

The recommended approach as shown above, is to split your Site Studio sync packages from your Drupal config using Config ignore and Config split modules. For more information, see Setup Config Ignore and Config Split.