Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions 16/umbraco-deploy/deployment-workflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ In summary:

### Deploying meta data

In order to be able to transfer content and media, the source environment and the target environment needs to have the same setup - meaning they need to be completely in sync and have the same file structure. To achieve this you need to deploy your meta data changes to the target environment.
To transfer content and media, the source and target environments needs to have the same setup. They need to be in sync and have the same file structure. To achieve this you need to deploy your meta data changes to the target environment.

* [Deploying from your local machine to your environments](deploying-changes.md)

### Transfer Content and Media

Moving your content and media between your environments is done through the Umbraco backoffice. You can transfer content from one environment to another, e.g. from local to your development environment. You also have the option to restore content and media to your local or development environment from your production or staging environment.
Moving your content and media between your environments is done through the Umbraco backoffice. You can transfer content from one environment to another, for example, from local to your development environment. You also have the option to restore content and media to your local or development environment from your production or staging environment.

* [Transfer Content and Media](content-transfer.md)
* [Restore Content and/or Media](restoring-content/)
Expand Down
2 changes: 1 addition & 1 deletion 16/umbraco-deploy/deployment-workflow/content-transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You want to transfer the whole site. You start from the `Home` node and choose t

1. Go to the Deployment dashboard by clicking on the Content section header.
* You will be able to see which items are currently ready to be transferred - this will include both content and media that you've _queued for transfer_.
2. Confirm by clicking **Transfer toDevelopment** and monitor the progress of the transfer.
2. Confirm by clicking **Transfer to Development** and monitor the progress of the transfer.

<figure><img src="../.gitbook/assets/image (1).png" alt="Transfer queue"><figcaption><p>Transfer queue</p></figcaption></figure>

Expand Down
2 changes: 1 addition & 1 deletion 16/umbraco-deploy/deployment-workflow/deploy-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This operation is useful if you want to move to another Umbraco instance and mig

<div align="left">

<figure><img src="../.gitbook/assets/image (9).png" alt="Donwload the Deploy artifacts"><figcaption><p>Donwload the Deploy artifacts</p></figcaption></figure>
<figure><img src="../.gitbook/assets/image (9).png" alt="Donwload the Deploy artifacts"><figcaption><p>Download the Deploy artifacts</p></figcaption></figure>

</div>

Expand Down
4 changes: 2 additions & 2 deletions 16/umbraco-deploy/deployment-workflow/deploying-changes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: "How to Deploy changes between a local machine and an environment in Umbraco Deploy using either a Git Gui or without."
description: "How to Deploy changes between a local machine and an environment in Umbraco Deploy using either a Git GUI or without."
---

# Deploying Changes
Expand Down Expand Up @@ -47,4 +47,4 @@ When pulling new commits, it is a good idea to see if any of these commits conta

The local site should be running when you do this. The deploy marker will change to `deploy-progress` while updating the site and to `deploy-complete` when done. If there are any conflicts/errors you will see a `deploy-failed` marker instead, which contains an error message with a description of what went wrong.

Another way is to use the Deploy Dashboard in the Settings section of the Umbraco backoffice. Here you can see the status of ongoing or completed deployment processes. The status will show whether an operation has been triggered and whether it is in progress, has completed or has failed. The dashboard will show the status based on the marker files on the disk, eg. `deploy-progress`. From the Deploy Dashboard it is also possible to trigger processes. Learn more about this dashboard in the [Deployment ](README.md#deploy-dashboard)article.
Another way is to use the Deploy Dashboard in the Settings section of the Umbraco backoffice. Here you can see the status of ongoing or completed deployment processes. The status will show whether an operation has been triggered and whether it is in progress, has completed or has failed. The dashboard will show the status based on the marker files on the disk, for example, `deploy-progress`. From the Deploy Dashboard it is also possible to trigger processes. Learn more about this dashboard in the [Deployment](README.md#deploy-dashboard)article.
8 changes: 4 additions & 4 deletions 16/umbraco-deploy/deployment-workflow/deploying-deletions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ With Umbraco Deploy deletions are environment specific. This means that in order

In this article you can read about the correct way of deleting files, schema and content when using Umbraco Deploy.

When you are using Umbraco Deploy, you might have more than one environment - including a local clone of the project. These environments each have their own database. The databases will contain references to all of your content and media, as well as to all of your schema files (e.g. Document Types, Templates etc).
When you are using Umbraco Deploy, you might have more than one environment - including a local clone of the project. These environments each have their own database. The databases contain references to all content, media, and schema files such as Document Types and Templates etc.

The databases are environment specific. When you deploy from one environment to another, Umbraco Deploy will compare incoming schema files with references to these in the databases using both _alias_ and _GUID_. If something doesn't add up - e.g. there is a mismatch between the database references and the files deployed - you will see an error. Learn more about this in the [Troubleshooting section](../troubleshooting.md).
Databases are environment-specific. When deploying between environments, Umbraco Deploy compares incoming schema files with database references using both _alias_ and _GUID_. If a mismatch occurs between the database references and deployed files, an error appears. Learn more in the [Troubleshooting section](../troubleshooting.md).

The workflow described above does not pick up deletions of content and schema from the database, which is why you'll need to delete the content and/or schema on all your environments, in order to fully complete the deletion.

Expand All @@ -32,15 +32,15 @@ Once the deployment is complete, you will notice the following:

You might wonder why the Document Type that you have deleted, is still there. The reason is, that deploy only deletes the associated UDA file, and not the actual Document Type in the database.

In order to completely delete the Document Type from your entire project, you need to delete it from the backoffice of any of the other environments you have as well. When the Document Type has been deleted from the backoffice of all environments and no UDA file exists, you can consider it completely gone.
To fully delete a Document Type from the project, delete it from the backoffice of every environment in use. A Document Type is fully deleted once it has been removed from all environments and no UDA file remains.

You should however keep in mind that if you at any point during the process, save your Document Type again, a UDA file will be regenerated and when you start deploying changes between environments, this will likely end up recreating your deleted Document Type.

## Which deletions are deployed?

Every **file** that's deleted, will also be deleted on the next environment when you deploy. However, there are some differences depending on what you have deleted.

Here's an overview of what happens when you deploy various deletions to the next environment.
Here's an overview of what happens when you deploy different deletions to the next environment.

### Deleting Schema (Document Types, Datatypes etc.)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,25 @@ The restore option also comes in really handy when you have content editors crea

There are four options when it comes to restoring content.

1. [Restore when starting up the project locally](./#restore-when-starting-up-the-project-locally)
2. [Restore everything through the Umbraco backoffice](./#restore-everything-through-the-umbraco-backoffice)
3. [Restore a single tree through the Umbraco backoffice](./#restore-a-single-tree-through-the-umbraco-backoffice)
1. [Restore when starting up the project locally](#restore-when-starting-up-the-project-locally)
2. [Restore everything through the Umbraco backoffice](#restore-everything-through-the-umbraco-backoffice)
3. [Restore a single tree through the Umbraco backoffice](#restore-a-single-tree-through-the-umbraco-backoffice)
4. [Partial Restores](partial-restore.md)

### Restore when starting up the project locally

The first time you run your project locally you will have the option to restore your content and media before going to the Umbraco backoffice.

{% hint style="info" %}
This will restore **all** content and media, plus any other entities configured for back-office transfer.
This will restore **all** content and media, plus any other entities configured for backoffice transfer.
{% endhint %}

1. When your site is done spinning up, click the green _Restore_ button - this will restore all content and media.
2. Wait till the process completes - this might take a while, depending on the amount of content and media you have on your Umbraco site.
3. When it's complete select _Open Umbraco_ to go to the backoffice.
4. You will now see all your content and media in the Umbraco backoffice.

![Restore from start-up](../../../umbraco-cloud/deployment/restoring-content/images/Normal-Restore.gif)
![Restore from start-up](images/Normal-Restore.gif)

### Restore everything through the Umbraco backoffice

Expand All @@ -45,7 +45,7 @@ The second option for restoring your content and media is found in the Umbraco b
7. When it's done, click **...** next to the Content tree again and choose _Reload_ to see your content in the tree.

{% hint style="info" %}
As well as content, media and any other entities configured for back-office transfer, will also be restored in the process.
As well as content, media and any other entities configured for backoffice transfer, will also be restored in the process.

To see the media, go to the Media section and _Reload_ the tree.
{% endhint %}
Expand All @@ -62,4 +62,4 @@ For example, if triggered from the content tree, only content entities will be r

### [Partial Restore](partial-restore.md)

By using the Partial Restore option, you can make sure that you only restore the part of the content that you need to work with. You can either restore a single item, or include all the descendents of that item too.
By using the Partial Restore option, you can make sure that you only restore the part of the content that you need to work with. You can either restore a single item, or include all the descendants of that item too.
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ You can use Partial Restore on
In this scenario you've cloned down your environment to your local machine or setup a new environment. In both cases the new environment will have an empty Content section as well as an empty Media section.

{% hint style="info" %}
Be aware that this feature will also restore all dependencies on the selected content.
This feature also restores all dependencies of the selected content.

E.g. when you restore a content node which references media items as well as other content nodes, these will all be restored as well, including any parent nodes that these nodes depend on.
For example, restoring a content node that references media or other content will also restore those items, including any parent nodes they depend on.
{% endhint %}

Follow these steps to perform a partial restore to get only the parts you need:
Expand Down Expand Up @@ -57,4 +57,4 @@ Imagine that you are working with your Umbraco project locally. One of your cont
6. Start the restore by clicking _Restore_
7. When the restore is done, reload the content tree to see the changes

![Partial restore](../../../umbraco-cloud/deployment/restoring-content/images/partialRestore-onEnvWithContent.png)
![Partial restore](images/partialRestore-onEnvWithContent.png)
2 changes: 1 addition & 1 deletion 16/umbraco-deploy/extending/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ If the optimal deployment workflow for your entity is to have editors control th

An introduction to this feature can be found in the second half of [this recorded session from Codegarden 2021](https://youtu.be/8bgZmlJ7ScI?t=938).

There's also a code sample, demonstrated in the video linked above, available [here](https://github.com/AndyButland/RaceData).
There's also a code sample, demonstrated in the video linked above, available at [GitHub](https://github.com/AndyButland/RaceData).

The following code shows the registration of an entity for Backoffice deployment, where we have the simplest case of a single tree for the entity.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ When working with Umbraco Cloud, this step is configured automatically for you w

The process works by using the marker file Umbraco Deploy uses to trigger an update of the Umbraco schema from the `.uda` files from source control.

If a file named `deploy-on-start` is found in the `/umbraco/Deploy` folder, an update will run automatically when the site starts up.
If a file named `deploy-on-start` is found in the `/umbraco/Deploy` folder, an update will run automatically when the site starts up.

Therefore, if we ensure that the file is created everytime the source code is pulled from the remote repository, we can automate the update.
Therefore, if we ensure that the file is created every time the source code is pulled from the remote repository, we can automate the update.

To do this, carry out the following steps:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ We then have a number of variables defined, that are used in the build configura

Most tasks in the pipeline are standard steps that will be used in any .NET web application release, such as the first steps:

\#1 Install of the NuGet tooling,
1. Install of the NuGet tooling,

\#2 Restore of NuGet dependencies,
2. Restore of NuGet dependencies,

\#3 And the project build.
3. And the project build.

Additional steps can be added as required, for example for running automated tests.

Expand All @@ -31,7 +31,8 @@ Firstly a web deployment (#4), takes the packaged build artifact and deploys it,
The final step (#5) is Umbraco Deploy specific - to call a function defined in the PowerShell script and trigger the extraction. Replace `ApiSecret` with `ApiKey` if you're using the deprecated API key setting instead.

{% hint style="info" %}
The Microsoft docs contain useful information, if you are unsure of how to set secrets for your pipeline:
The Microsoft documentation contain useful information, if you are unsure of how to set secrets for your pipeline:

* [Set secret variables](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/set-secret-variables?view=azure-devops&tabs=yaml%2Cbash)

* [Protecting secrets in Azure Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/security/secrets?view=azure-devops)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The following steps will take you through setting up a build server in Azure Web

![Azure deployments](<../../../../10/umbraco-deploy/getting-started/images/Deployment-center (1) (1).png>)

In the Deployment Center we can set up the CI/CD build server. With this example we are going to set up our build server by using GitHub Actions. It is possible to set up the build server however you want as long as it supports executing powershell scripts.
In the Deployment Center we can set up the CI/CD build server. With this example we are going to set up our build server by using GitHub Actions. It is possible to set up the build server however you want as long as it supports executing Powershell scripts.

2. Go to the Settings tab.
3. Choose which source and build provider to use.
Expand Down
18 changes: 9 additions & 9 deletions 16/umbraco-deploy/getting-started/deploy-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ If no value is set, Deploy will create 16MB chunks, unless the [CMS `MaxRequestL

### TransferFormsAsContent {#transfer-forms-data-as-content}

In order for Deploy to handle Forms data as content, you'll to ensure the `TransferFormsAsContent` setting is set to `true`. To transfer Forms data as schema, i.e. via .uda files committed to source control, use a value of `false`.
In order for Deploy to handle Forms data as content, you'll to ensure the `TransferFormsAsContent` setting is set to `true`. To transfer Forms data as schema via .uda files committed to source control, use a value of `false`.

{% hint style="info" %}
On changing this value from `false` to `true`, make sure to remove any `.uda` files for Forms entities that have already been serialized to disk. These will no longer be updated. By deleting them you avoid any risk of them being processed in the future and inadvertently reverting a form to an earlier state.
Expand Down Expand Up @@ -502,15 +502,15 @@ To avoid this handler from being registered, you can set this setting to `false`

### Import on startup {#import-on-startup}

Deploy can [import content and/or schema previously exported from another Umbraco installation on start-up](../deployment-workflow/import-on-startup.md). This can be customized by changing the `Umbraco:Deploy:ImportOnStartup` settings (note that this is directly below the `Deploy` section and not nested below `Settings`):
Deploy can [import content and/or schema previously exported from another Umbraco installation on start-up](../deployment-workflow/import-on-startup.md). Change the `Umbraco:Deploy:ImportOnStartup` settings to customize it. This is directly below the `Deploy` section and not nested below `Settings`:

* `Enabled` - this feature is enabled by default, but can be disabled (e.g. to prevent importing on specific environments)
* `Files` - the files that are imported on start-up (relative to the project content root, defaults to `umbraco\Deploy\import-on-startup.zip`), which are checked individually (files that do not exist are skipped and a warning will be logged)
* `FileAction` - `None` will leave the file on disk (and potentially import it again on the next start-up), `Archive` renames the file to end with `.imported` and `Delete` (the default) will remove the file on successful import
* `WarningsAsErrors` - indicates whether warnings should be considered as errors
* `EntityTypes` - sets the entity types to import, note that the default import validation will return warnings for entity types in the ZIP archive that are skipped due to this setting
* `Cultures` - the ISO codes of content variants that should be imported
* `Username` - the email address of the user that performs the import (used for auditing), uses the 'super-user' administrator account if not set
* `Enabled` - this feature is enabled by default, but can be disabled (for example, to prevent importing on specific environments).
* `Files` - the files that are imported on start-up (relative to the project content root, defaults to `umbraco\Deploy\import-on-startup.zip`), which are checked individually (files that do not exist are skipped and a warning will be logged).
* `FileAction` - `None` will leave the file on disk (and potentially import it again on the next start-up), `Archive` renames the file to end with `.imported` and `Delete` (the default) will remove the file on successful import.
* `WarningsAsErrors` - indicates whether warnings should be considered as errors.
* `EntityTypes` - sets the entity types to import. The default import validation will return warnings for entity types in the ZIP archive that are skipped due to this setting.
* `Cultures` - the ISO codes of content variants that should be imported.
* `Username` - the email address of the user that performs the import (used for auditing), uses the 'super-user' administrator account if not set.

## Configuration via code

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The process works by using the marker file Umbraco Deploy uses to trigger an upd

If a file named `deploy-on-start` is found in the `/umbraco/Deploy` folder, an update will run automatically when the site starts up.

Therefore, if we ensure that the file is created everytime the source code is pulled from the remote repository, we can automate the update.
Therefore, if we ensure that the file is created every time the source code is pulled from the remote repository, we can automate the update.

To do this, carry out the following steps:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading