Version Control System Version 7.18 This Documentation Is Provided Under Restrictions on Use and Are Protected by Intellectual Property Laws
Total Page:16
File Type:pdf, Size:1020Kb
Version control system Version 7.18 This documentation is provided under restrictions on use and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this documentation, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. © 2021 Creatio. All rights reserved. Table of Contents | 3 Table of Contents Version control in Creatio IDE 5 Committing a package to storage 5 Installing packages from repository 6 Updating package from repository 6 Committing a package to repository 6 Installing packages from repository 7 Package installation sequence 7 Changes in package hierarchy 9 Updating package from repository 10 The sequence of package update from SVN 11 Version control in Subversion 11 General outline 12 Versioning models 13 Determining the state of the working copy file 13 Working copy used in Creatio 14 Using an application to work in SVN 14 Create a package in the file system development mode 14 1. Create a package in the application 15 2. Download created package to file system 16 3. Create necessary folders for the packages in the SVN repository 17 4. Create a working copy of the package version branch 18 5. Commit the package folder in the repository 20 Install an SVN package in the file system development mode 21 The procedure for installing an SVN package in the file system development mode 21 Case description 22 Case implementation algorithm 22 Bind an existing package to SVN 26 The general sequence for binding a package to the repository 26 Case description 26 Case implementation algorithm 27 Alternative implementation 33 Update and commit changes to the SVN from the file system 35 Case description 35 Updating the package 35 Package contents modifications 37 Committing a package to storage 38 © 2021 Creatio. All rights reserved. Table of Contents | 4 Create the package and switch to the file system development mode 39 Introduction 39 Case description 39 Case implementation algorithm 39 Version control in Git 45 Introduction 46 Working with Git in Creatio 46 Configure working with Git 46 Step 1. Enable the file system development mode 46 Step 2. Create a package without binding it to the repository 46 Step 3. Create the required package schemas. 47 Step 4. Export the package to the file system. 47 Step 5. Add the required source code 48 Step 6. Commit the changes to the version control system 48 Step 7. Install an updated package in the application 49 Step 8. Generate source codes 50 Step 9. Compiling the changes 50 Step 10. Updating the database structure 50 Step 11. Installing SQL scripts and bound data 50 © 2021 Creatio. All rights reserved. Version control in Creatio IDE | 5 Version control in Creatio IDE Easy Creatio IDE implements a set of tools for working with the SVN version control system. Commiting a package, updating a package or installing it from a repository using the built-in Creatio tools is not possible when development mode is enabled in the file system. Committing a package to storage Committing package to storage is adding all package modifications to the SVN storage. Packages are commited manually. Modifications of other configuration packages are not committed. Package committing is required when: creating a new package adding new and modifying existing package components deleting package components modifying package properties The system displays the names of custom packages that have not been committed yet and the name of the storage the packages will be committed to (1). The SVN revision number is not displayed. and will be added after the committing. Such packages are locked by default. The system displays the names of custom packages that have already been committed, the name of the storage and the latest SVN revision number. The basic package is displayed in the same way as the custom package (2). If a custom package has been modified, its name will be displayed in bold (3). Attention. If an element was deleted from a package (for example, schema or SQL script), then those modifications won’t affect the package display. © 2021 Creatio. All rights reserved. Committing a package to repository | 6 Installing packages from repository Installing a package from the repository is adding the package and all its dependencies from the version control system repository (SVN) to Creatio. Package installation is required when: Multiple developers work on the package functionality. Changes are transferred between applications. Updating package from repository The package upgrade process is downloading to the application all changes of the selected package and all its dependencies changes from the version control system storage (SVN). Committing a package to repository Easy To commit a package to storage, first, select it on the [ Packages ] tab. In the context menu, select the [ Commit package to storage ] action. Attention. When the file system development mode is enabled, the SVN integration mechanism is turned off. Therefore, the [ Commit package to repository ] action is unavailable. As a result, the [ Changes ] window will open. © 2021 Creatio. All rights reserved. Installing packages from repository | 7 You must add a comment in the [ Description ] window when committing a package. For example, describe the modifications made to the package. The committed files are displayed in the bottom of the window. After pressing the [ Commit Changes to Repository ] button, the package will be committed and the modifications will be become available for other system users. Attention. The is committed to the storage specified in its properties. Packages can only be committed to an active storage. When a package is committed, the lock is removed. The package and its components become available for other system users. Installing packages from repository Easy Attention. The information below are applicable when working with SVN repositories via the Creatio built-in development tools. The information are not applicable when the file system design mode is turned on (see "Version control in Subversion"). Package installation sequence Attention. Before updating the application via SVN, you must back up the database. If the application is deployed in the cloud, you should contact support. Please note that you cannot revert to the previous version of the application via SVN. The package is installed from the repository using the actions in the [ Configuration ] section. More details about this section tools can be found in the "The [ Configuration ] section” article. To install the package from the repository, go to the [ Configuration ] section, right-click the [ Packages ] tab and © 2021 Creatio. All rights reserved. Installing packages from repository | 8 select the [ Install Package from Repository ] option. Then, in the dialog box, select the repository, the name and version of the package to install, and then click the [ Install ] button. During the package installation, the bound data will be automatically applied, and dependencies will be installed. If, for any reason, the automatic application of changes has not been enabled, then changes must be applied manually. To do this, perform the following actions for the installed package in the [ Configuration ] section: 1. Generate the source codes for items that require it. 2. Compile the modified items. 3. Update the database structure. 4. Install SQL scripts if necessary. 5. Install the connected data. Note. Checkboxes in the [ Database Update Required ] and [ Require database installation ] columns on the [ Schemas ], [ SQL scripts ] and [ Data ] tabs of the [ Configuration section ] indicate that a schema, script or data needs to be installed in the database or requires modification of the database structure. In case of errors, the text of the last error can be seen in the [ Last error message text ] column. Please note that not all of these columns are displayed on the [ Schemas ], [ SQL scripts ] and [ Data ] tabs of the [ Configuration ] section. If necessary, you can add them using the [ Columns setup ] context menu. Attention. After installing or updating a package from SVN, Creatio application requires compilation (the [ Compile all items ] action in the [ Configuration ] section). In the process of compilation, the static content © 2021 Creatio. All rights reserved. Installing packages from repository | 9 will be generated (see "Client static content in the file system" article). Changes in package hierarchy When you install a custom package, the system checks its dependencies and optionally installs or upgrades all the packages the current package depends on. For example, when you install the [ UsrCustomPackage ] package from the repository, the [ UsrDependentPackage ] package dependency will also be installed. This modifies the package hierarchy in the application. When a custom package is installed from SVN, the package hierarchy will be modified in the following way: 1) The application detects all dependencies of the installed package specified in its metadata in the DependsOn © 2021 Creatio. All rights reserved. Updating package from repository | 10 property. { "Descriptor": { "UId": "8bc92579-92ee-4ff2-8d44-1ca61542aa1b",