-
Notifications
You must be signed in to change notification settings - Fork 811
Add Deploy 13.3.0 and 14.2.0 release notes and document ImportOnStartup and ValidateDependenciesOnImport settings #6699
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
eshanrnh
merged 23 commits into
umbraco:main
from
ronaldbarendse:deploy/release-notes-13.3-14.2
Nov 26, 2024
Merged
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
e5ca81e
Add Deploy 13.3 and 14.2 release notes
ronaldbarendse cc1466d
Update Deploy screenshots and clean up duplicate/unused images
ronaldbarendse 56a3a11
Add ImportOnStartup documentation
ronaldbarendse 816acc0
Add ValidateDependenciesOnImport documentation
ronaldbarendse e059836
Update 10/umbraco-deploy/deployment-workflow/content-transfer.md
eshanrnh 7af8115
Update 13/umbraco-deploy/deployment-workflow/content-transfer.md
eshanrnh 6b5aca0
Update 14/umbraco-deploy/deployment-workflow/content-transfer.md
eshanrnh a12f4c2
Update umbraco-cloud/deployment/README.md
eshanrnh ba812e7
Update 15/umbraco-deploy/deployment-workflow/import-export.md
eshanrnh 6c7051b
Move 'Import on startup' to dedicated page
ronaldbarendse 394ab31
Fix typo
ronaldbarendse 56108b9
Update 13/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh d44b819
Update 15/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh eeee300
Update 15/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh 734b763
Update 15/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh 57c9bbb
Update 15/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh 4c970db
Update 14/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh 50360a4
Update 14/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh c04d70a
Update 14/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh b497ba9
Update 14/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh 147c5ac
Update 13/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh 172160e
Update 13/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh 8537bb8
Update 13/umbraco-deploy/deployment-workflow/import-on-startup.md
eshanrnh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-72.5 KB
10/umbraco-deploy/deployment-workflow/images/deletions-of-doctype.png
Binary file not shown.
Binary file removed
BIN
-33.6 KB
10/umbraco-deploy/deployment-workflow/images/deletions-of-doctype2 (1).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
...deploy/deployment-workflow/images/left-to-right (1) (1) (1) (1) (1) (1) (1).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
...deploy/deployment-workflow/images/left-to-right (1) (1) (1) (1) (1) (1) (2).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
...aco-deploy/deployment-workflow/images/left-to-right (1) (1) (1) (1) (1) (1).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
...aco-deploy/deployment-workflow/images/left-to-right (1) (1) (1) (1) (1) (2).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
10/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1) (1) (1) (1).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
10/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1) (1) (1) (2).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
10/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1) (1) (1).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
10/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1) (1) (2).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
10/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1) (1).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
10/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1) (2).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
10/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1).png
Binary file not shown.
Binary file removed
BIN
-6.9 KB
10/umbraco-deploy/deployment-workflow/images/left-to-right (1) (2).png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-24.8 KB
10/umbraco-deploy/deployment-workflow/images/queue-for-transfer-dialog (1).png
Binary file not shown.
Binary file removed
BIN
-456 KB
10/umbraco-deploy/deployment-workflow/images/restart-environment.gif
Binary file not shown.
Binary file removed
BIN
-62.6 KB
10/umbraco-deploy/deployment-workflow/images/schema-mismatch (1).png
Binary file not shown.
Binary file removed
BIN
-62.6 KB
10/umbraco-deploy/deployment-workflow/images/schema-mismatch (2).png
Binary file not shown.
Binary file removed
BIN
-3.93 MB
10/umbraco-deploy/deployment-workflow/images/stage-commit-deploy.gif
Binary file not shown.
Binary file removed
BIN
-12.7 KB
10/umbraco-deploy/deployment-workflow/images/transfer-queue (1).png
Binary file not shown.
Binary file removed
BIN
-12.7 KB
10/umbraco-deploy/deployment-workflow/images/transfer-queue (2).png
Diff not rendered.
Diff not rendered.
Binary file removed
BIN
-46.7 KB
10/umbraco-deploy/deployment-workflow/images/umbraco-deploy-config.png
Diff not rendered.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Diff not rendered.
Diff not rendered.
Diff not rendered.
Oops, something went wrong.
Binary file removed
BIN
-72.5 KB
13/umbraco-deploy/deployment-workflow/images/deletions-of-doctype.png
Diff not rendered.
File renamed without changes
Binary file added
BIN
+21.9 KB
13/umbraco-deploy/deployment-workflow/images/export-complete-dialog.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file removed
BIN
-6.9 KB
13/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1) (1).png
Diff not rendered.
Binary file removed
BIN
-6.9 KB
13/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1) (2).png
Diff not rendered.
Binary file removed
BIN
-6.9 KB
13/umbraco-deploy/deployment-workflow/images/left-to-right (1) (1).png
Diff not rendered.
Binary file removed
BIN
-6.9 KB
13/umbraco-deploy/deployment-workflow/images/left-to-right (1) (2).png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed
BIN
-456 KB
13/umbraco-deploy/deployment-workflow/images/restart-environment.gif
Diff not rendered.
Binary file removed
BIN
-62.6 KB
...braco-deploy/deployment-workflow/images/schema-mismatch (1) (1) (1) (1) (1).png
Diff not rendered.
Binary file removed
BIN
-62.6 KB
13/umbraco-deploy/deployment-workflow/images/schema-mismatch (1) (1) (1) (1).png
Diff not rendered.
Binary file removed
BIN
-62.6 KB
13/umbraco-deploy/deployment-workflow/images/schema-mismatch (1) (1) (1).png
Diff not rendered.
Binary file removed
BIN
-62.6 KB
13/umbraco-deploy/deployment-workflow/images/schema-mismatch (1) (1).png
Diff not rendered.
Binary file removed
BIN
-62.6 KB
13/umbraco-deploy/deployment-workflow/images/schema-mismatch (1).png
Diff not rendered.
Binary file removed
BIN
-3.93 MB
13/umbraco-deploy/deployment-workflow/images/stage-commit-deploy.gif
Diff not rendered.
Oops, something went wrong.
Binary file removed
BIN
-46.7 KB
13/umbraco-deploy/deployment-workflow/images/umbraco-deploy-config.png
Diff not rendered.
Binary file added
BIN
+44.5 KB
13/umbraco-deploy/deployment-workflow/images/workspace-export-dialog.png
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
13/umbraco-deploy/deployment-workflow/import-on-startup.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| meta.Title: Import on startup | ||
| description: How to import content and schema on startup and implement your own `IArtifactImportOnStartupProvider` | ||
| --- | ||
|
|
||
| # Import on startup | ||
|
|
||
| Deploy can import content and/or schema previously exported from another Umbraco installation on start-up. This allows for a quick setup of a baseline/starter kit or serves as a workaround for large ZIP archives that cannot be uploaded via the backoffice. | ||
|
Check warning on line 8 in 13/umbraco-deploy/deployment-workflow/import-on-startup.md
|
||
|
|
||
| ## Default configuration | ||
|
|
||
| The default configuration will look for the ZIP archive `umbraco\Deploy\import-on-startup.zip` on start-up and if it exists, run an import and delete the file on successful completion. If you want to customize the default behavior, do so via [settings](../getting-started/deploy-settings.md#import-on-startup). | ||
|
Check warning on line 12 in 13/umbraco-deploy/deployment-workflow/import-on-startup.md
|
||
|
|
||
| This feature is extensible via a provider-based model by implementing `IArtifactImportOnStartupProvider` and registering it using `builder.DeployArtifactImportOnStartupProviders()`. The default `Umbraco.Deploy.Infrastructure.SettingsArtifactImportOnStartupProvider` implementation uses the above settings and inherits from `Umbraco.Deploy.Infrastructure.ArtifactImportOnStartupProviderZipArchiveBase` (which can be used for your own custom implementation). | ||
|
|
||
| ## Implementing your own `IArtifactImportOnStartupProvider` | ||
|
|
||
| An example of an import on a start-up provider that imports from a physical directory (instead of ZIP archive) is shown below: | ||
|
|
||
| ```csharp | ||
| using Umbraco.Cms.Core; | ||
| using Umbraco.Cms.Core.Composing; | ||
| using Umbraco.Cms.Core.Extensions; | ||
| using Umbraco.Deploy.Core; | ||
| using Umbraco.Deploy.Core.OperationStatus; | ||
| using Umbraco.Deploy.Infrastructure.Extensions; | ||
|
|
||
| internal sealed class DeployImportOnStartupComposer : IComposer | ||
| { | ||
| public void Compose(IUmbracoBuilder builder) | ||
| => builder.DeployArtifactImportOnStartupProviders() | ||
| .Append<PhysicalDirectoryArtifactImportOnStartupProvider>(); | ||
|
|
||
| private sealed class PhysicalDirectoryArtifactImportOnStartupProvider : IArtifactImportOnStartupProvider | ||
| { | ||
| private readonly IArtifactImportExportService _artifactImportExportService; | ||
| private readonly ILogger _logger; | ||
| private readonly string _artifactsPath; | ||
|
|
||
| public PhysicalDirectoryArtifactImportOnStartupProvider(IArtifactImportExportService artifactImportExportService, ILogger<PhysicalDirectoryArtifactImportOnStartupProvider> logger, IHostEnvironment hostEnvironment) | ||
| { | ||
| _artifactImportExportService = artifactImportExportService; | ||
| _logger = logger; | ||
| _artifactsPath = hostEnvironment.MapPathContentRoot("~/umbraco/Deploy/ImportOnStartup"); | ||
| } | ||
|
|
||
| public Task<bool> CanImportAsync(CancellationToken cancellationToken = default) | ||
| => Task.FromResult(Directory.Exists(_artifactsPath)); | ||
|
|
||
| public async Task<Attempt<ImportArtifactsOperationStatus>> ImportAsync(CancellationToken cancellationToken = default) | ||
| { | ||
| _logger.LogInformation("Importing Umbraco content and/or schema import at startup from directory {FilePath}.", _artifactsPath); | ||
|
|
||
| Attempt<ImportArtifactsOperationStatus> attempt = await _artifactImportExportService.ImportArtifactsAsync(_artifactsPath, default, null, cancellationToken); | ||
|
|
||
| _logger.LogInformation("Imported Umbraco content and/or schema import at startup from directory {FilePath} with status: {OperationStatus}.", _artifactsPath, attempt.Result); | ||
|
|
||
| return attempt; | ||
| } | ||
|
|
||
| public Task OnImportCompletedAsync() | ||
| { | ||
| Directory.Delete(_artifactsPath, true); | ||
|
|
||
| return Task.CompletedTask; | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.