|
1 | 1 | # Deployment Artifact best practice |
2 | | -The zip package you are deploying needs to contain all things that normally is present in an Umbraco Cloud environment-repository. |
3 | 2 |
|
4 | | -Every new Umbraco Cloud project contains a readme.md file which explains the structure and how you can adapt it to suit your needs. |
| 3 | +The zip package you are deploying needs to contain all things that are normally present in an Umbraco Cloud environment repository. |
5 | 4 |
|
6 | | -The sample scripts on GitHub includes a way to package the zip. As the scripts are samples they show a universal way to do this which works well for most people. But not all projects are alike, and you may not want to use that particular approach. |
| 5 | +Every new Umbraco Cloud project contains a `readme.md` file which explains the structure and how you can adapt it to suit your needs. |
7 | 6 |
|
8 | | -## Do not include Dotnet Binaries |
9 | | -Don’t include any binary build artifacts coming from the DotNet build/publish process. |
| 7 | +The sample scripts on GitHub include a way to package the zip. As the scripts are samples, they show a universal way to do this, which works well for most people. But not all projects are alike, and you may not want to use that particular approach. |
10 | 8 |
|
11 | | -The general deployment process on Umbraco Cloud needs the source code and the system will rebuild it once it is pushed back to the environment. |
| 9 | +## Do not include .NET Binaries |
| 10 | + |
| 11 | +Don’t include any binary build artifacts coming from the .NET build/publish process. |
| 12 | + |
| 13 | +The general deployment process on Umbraco Cloud needs the source code, and the system will rebuild it once it is pushed back to the environment. |
| 14 | + |
| 15 | +## Do not include the `.git` directory |
12 | 16 |
|
13 | | -## Do not include the .git directory |
14 | 17 | The folder will be ignored in the isolated instance, including the extra megabytes will slow down the deployment process. |
15 | 18 |
|
16 | | -Also consider the artifact size limitation below. |
| 19 | +Also, consider the artifact size limitation below. |
17 | 20 |
|
18 | 21 | ## Do include the finished frontend assets |
19 | | -If you are using modern frontend build tools, ideally only include the finished frontend assets that are needed. No need to include JavaScript or TypeScript source files if you need to build the frontend. |
| 22 | + |
| 23 | +If you are using modern frontend build tools, only include the finished frontend assets that are needed. There is no need to include JavaScript or TypeScript source files if you need to build the frontend. |
20 | 24 |
|
21 | 25 | ## Keep the Artifact as small as possible |
| 26 | + |
22 | 27 | It is good practice to keep the zipped artifact as small as possible. |
23 | | -* Large files will slow down the underlying git operations and therefore also the deployment process. |
24 | | - * Do not include large files like pictures and pdf’s in the artifact. |
| 28 | + |
| 29 | +* Large files will slow down the underlying git operations and, therefore, also the deployment process. |
| 30 | + * Do not include large files like pictures and PDFs in the artifact. |
25 | 31 | * Large files need to be uploaded to the blob storage connected to your environment. |
26 | 32 | * Remove old and leftover code from the artifact. |
27 | | - * Orphaned Csproj-files with outdated package-references are common causes for issues in the deployment process. |
| 33 | + * Orphaned `.csproj` files with outdated package references are a common cause for issues in the deployment process. |
28 | 34 |
|
29 | 35 | Size limitations to consider: |
30 | | -- The V1 endpoint will allow file sizes up to 128 MB. |
31 | | -- In the V2 endpoint we have increased the size limit to 256 MB. |
| 36 | + |
| 37 | +- The version 1 endpoints will allow file sizes up to 128 MB. |
| 38 | +- In version 2 endpoints, the size limit is increased to 256 MB. |
0 commit comments