Creating components from a versioned file system#

To import artifacts with versions, create a directory with subdirectories that represent the versions of the artifacts. Then, create the component with the File System (Versioned) source configuration type.

To create this type of component, first arrange the artifacts inside a parent folder for the component and then arrange the artifacts inside subfolders for each version of the component. For example, the following file structure shows a component with three versions and two files in each version:

myComponent/
  1.0/
    fileA.txt
    fileB.txt
  2.0/
    fileA.txt
    fileC.txt
  experimental/
    fileA.txt
    fileD.txt
  1. In UrbanCode™ Deploy, click Components, and then click Create Component.

  2. In the Create Component window, specify a name and description for the component.

  3. In the Teams fields, specify the access information for the new component.

  4. To use a template for the new component, select a template from the Template list.

    In this case, the component inherits source configuration, properties, and processes from the template. For information about templates, see Component templates.

  5. In the Source Configuration Type list, select File System (Versioned).

  6. Specify the following parameters for the component:

    • *Base Path*

      Specify the path to the directory that contains the artifacts. The content of each subdirectory within this base directory is considered a distinct component version. The subdirectory with the most recent time stamp is considered to be the latest version.

    • *Preserve Execute Permissions*

      For Linux™ and UNIX™ operating systems, select this check box to retain the execute permissions for each file.

    • *Text File Extensions*

      If text-type files must be converted into another character set, type the list of file extensions to be converted. Matching file types are converted into the default or system character set of the system where the agent is located. Separate list items with commas, for example:

      txt,log,ini,sh

    • *Import Versions Automatically*

      Select this check box to check for new versions periodically and to import new versions automatically. If you do not import versions automatically, you can import versions manually by clicking Components > selected component > Versions and then clicking Import New Versions.

    • *Copy to CodeStation*

      This option, which is selected by default, creates tamper-protected copies of the artifacts and stores them in the embedded artifact management system, CodeStation. If the check box is cleared, only metadata about the artifacts is imported. In most cases, keep this check box selected. The default for this setting is in the system setting Components copy to CodeStation by default. For more information, see Server settings.

    • *Default Version Type*

      Specify how to import versions into CodeStation:

      • *Full*

        Each version is comprehensive and contains all artifacts.

      • *Incremental*

        Each version contains a subset of artifacts.

    • *Use the system's default version import agent/tag*

      If this parameter is selected, the agent or tag that you specified on the System Settings page is used to import component artifacts. Agents must have access to the system where the artifacts are located. For more information, see Server settings.

    • *Import new component versions using a single agent*

      If this parameter is selected, use the Agent for Version Imports field to identify the agent that is used to import artifacts into the component. The agent must have access to the system where the artifacts are located. To import artifacts from where the server is located, install an agent in the same location and specify that agent.

    • *Import new component versions using any agent with the specified tag*

      If this parameter is selected, use the Agent Tag for Version Imports field to identify the tag that is used to select agents to import artifacts into the component. All tagged agents must have access to the system where the artifacts are located.

    • *Use Default Artifact Cleanup Settings*

      To apply the component version cleanup settings that are specified on the System Settings page, select the Use Default Artifact Cleanup Settings check box. If this check box is cleared, you must specify how long to keep component versions. For more information about cleaning up component versions, see Cleaning up component versions.

    • *Run Process after a Version is Created*

      To automatically run a process after versions are imported, select this check box, and then specify an application process and an environment for the process. The process runs only when the version is imported automatically, not when you import versions manually. Similarly, the process does not run when you create versions with the REST API or the udclient command. If the automatic version import finds multiple versions, the process runs only once.

  7. Click Save.

The new component is listed on the Components page. The Versions tab shows the available versions of the component. If you selected the Import Versions Automatically check box, versions are displayed automatically. Otherwise, click Import New Versions to show the available versions. Depending on the number and size of the artifacts, it might take time before the versions are displayed. To see the artifacts in the component, click a component version.

Create processes for the component. See Creating component processes.

Parent topic: Creating components from the file system