Customization > Deploying Code and Configuration Package > Trigger Automated Deploy
Trigger Automated Deploy
To trigger the package deployment, you need a manifest file. The manifest file is an YML file that describes where and when a specific build should be deployed. The steps to create a manifest file are as follows:
Creating Manifest File
The environment that defines the deployment pipeline should be configured by PTC Cloud, and the corresponding environment identifiers should be obtained from the PTC team before proceeding to the next steps.
* 
• Use any text editor to create the manifest file.
• The filename name must be manifest_<text>.yml. Here <text> can be a custom text specified by you. For example, manifest_build1.yml, manifest_package1.yml, and so on.
• You can reuse the same filename every time or create a new one for each package being deployed.
Details of the attributes in manifest file are given below:
Attribute
Description
Possible Values
deploy_pipe
Defines the pipeline where the build package should be installed. The deploy_pipe attribute lists the environments to deploy the build. Normally, intN describes a single Integration environment and pipelineN describes both QA and Production environments.
intN or pipelineN
examples:
• deploy_pipe: pipeline1
• deploy_pipe: int1
* 
• intN or pipelineN are not the default values, but the possible values. For the exact values, contact PTC.
• You cannot add multiple values for deploy_pipe.
package_description
Brief description of the build package contents or its purpose.
You can specify text of your choice. You can add information related to the updates.
For example, Package for TEST deploy, Change Number: B178542, Added the new features, and so on.
package_name
File name of the build package with the extension .zip.
<Build>.zip
* 
• The package name is case sensitive.
• The package_name must match the name of the package uploaded to the storage account.
• Ensure that you have a unique name for the .zip file that can be easily matched with the version number. For example, JulyRelease_v4.2, FeatureUpdate_v1.6, and so on.
package_type
Type of deployment.
CCD or SCF
* 
If no value is specified, the default value SCF is applied.
duration
Expected deployment duration time in hours.
Number. For example, 2.
date_time_int
Expected date when the build should be deployed on the Integration environment.
* 
Time is in 24H format in Eastern Time.
YYYY/MM/DD hh:mm:ss
2021/01/30 14:00:00
date_time_qa
Expected date when the build should be deployed on the QA environment.
* 
Time is in 24H format in Eastern Time.
YYYY/MM/DD hh:mm:ss
2021/01/30 14:00:00
date_time_prod
Expected date when the build should be deployed on the Production environment.
* 
Time is in 24H format in Eastern Time.
YYYY/MM/DD hh:mm:ss
2021/01/30 14:00:00
notify
Comma-separated list of emails for sending notifications during the deployment process.
user1@company.com,user2@company.com
approvers
Comma-separated list of emails for approval notifications during the deployment process.
approver1@company.com,approver2@company.com
retention_period
Snapshot retention period for the CCD deployment.
7 or 30
* 
• For a single environment deployment, the retention_period value is set to 7 if no value or any value other than 7 or 30 is specified.
• For a pipeline environment deployment, the retention_period value is set to 30 for both the QA and Production environments, regardless of any value specified for this attribute.
An example of the manifest file with the deploy_pipe value set to int is as below.
#Describes the deployment of build pipeline
deploy_pipe : int1
package_description : Package for TEST deploy
package_name : Version1.zip
package_type : CCD
duration : 2
date_time_int : 2023/06/09 14:00:00
notify : user1@company.com
approvers : approver1@company.com,approver2@company.com
retention_period : 7
An example of the manifest file with the deploy_pipe value set to pipeline is as below.
#Describes the deployment of build pipeline
deploy_pipe: pipeline1
package_description : Package for TEST deploy
package_name : version2.zip
package_type : CCD
duration : 2
date_time_qa : 2023/06/12 14:00:00
date_time_prod : 2023/06/15 14:00:00
notify : user1@companyname.com
approvers : approver1@company.com,approver2@company.com
* 
The package_name must match the name of the package uploaded to the storage account. Ensure that you have a unique name for the .zip file that can be easily identified by you.
You cannot deploy the same build package twice to an instance.
Once deployed, you cannot use the same package for another deployment.
Upload the Manifest File from a Local Computer
To upload using the manifest file using Linux shell, execute the following commands:
cd /<path>
azcopy login
azcopy cp <manifest>.yml https://ptccustomerxxxxrrr.blob.core.windows.net/data/builds/deploy/
To upload using Windows CMD or PowerShell, execute the following commands:
cd \<path>
azcopy login
azcopy cp <manifest>.yml https://ptccustomerxxxxrrr.blob.core.windows.net/data/builds/deploy/
To upload the manifest file using Microsoft Azure Storage Explorer:
1. Locate the manifest file locally. Locate the target folder (data/builds/deploy) in the Blob Container.
2. Either drag and drop or upload the manifest file to the target folder.
* 
If you are prompted for Storage Access Policy, click OK.
3. After the transaction is complete, verify the transfer status is successful.
Was this helpful?