Difference between revisions of "Project Configuration Files"

From Lingoport Wiki
Jump to: navigation, search
(Created page with "<group_name> ├── config │ ├── config_due_dates.xml │ ├── config_file_cherry_picker.xml │ ├── config_l10n_vendor.properties │ ├──...")
 
Line 1: Line 1:
  +
Under the L10n Streamlining directory (typically ~jenkins/Lingoport_Data/L10nStreamlining), each group file structure follows this pattern:
  +
  +
<pre>
 
<group_name>
  
<group_name>
 
├── config
  
├── config
−
│ ├── config_due_dates.xml
 +
│   ├── config_due_dates.xml
−
│ ├── config_file_cherry_picker.xml
 +
│   ├── config_file_cherry_picker.xml
−
│ ├── config_l10n_vendor.properties
 +
│   ├── config_l10n_vendor.properties
−
│ ├── config_lingotek_locale_mapping.properties
 +
│   ├── config_lingotek_locale_mapping.properties
−
│ ├── config_lrm_info.properties
 +
│   ├── config_lrm_info.properties
−
│ └── config_pseudo_loc.xml
 +
│   └── config_pseudo_loc.xml
 
└── projects
  
└── projects
 
└── <project 1>
  
└── <project 1>
 
├── config
  
├── config
−
│ ├── config_email_recipients.xml
 +
│   ├── config_email_recipients.xml
−
│ └── config_vcs.properties
 +
│   └── config_vcs.properties
  +
...
  +
</pre>
  +
Each of the group configuration files can be copied to the project 'config' directory is a project has a configuration different from most projects in that group. For more information on the group configuration files, visit the [[Group Configuration File]] page.
  +
  +
This section describes the configuration files for each project.
  +
  +
== config_email_recipients.xml ==
  +
The notification (email) mechanism uses this file to determine which emails are sent to what recipients.
  +
  +
The file is formatted this way:
  +
<pre>
  +
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  +
<email-recipients>
  +
<notify-changes>
  +
<recipient>name1@company.com</recipient>
  +
<recipient>name2@company.com</recipient>
  +
</notify-changes>
  +
<prep-kit>
  +
<recipient>name@company.com</recipient>
  +
</prep-kit>
  +
<import-kit>
  +
<recipient>name1@company.com</recipient>
  +
<recipient>name2@company.com</recipient>
  +
</import-kit>
  +
<translators>
  +
<translator>name@company.com</translator>
  +
</translators>
  +
<l10nvendoradmins>
  +
<l10nvendoradmin>name@company.com</l10nvendoradmin>
  +
</l10nvendoradmins>
  +
</email-recipients>
  +
  +
</pre>
  +
  +
== config_vcs.properties ==
  +
This file tells what Version Control System to use and the URL of the repository project for checkin and checkout.
  +
A typical file looks like this:
  +
<pre>
  +
# Choices for VCS_TYPE are:
  +
# - git
  +
# - svn
  +
VCS_TYPE=svn=
  +
  +
# For GIT:
  +
# Uncomment the following and fill in the properties
  +
#VCS_GIT_URL=git@github.com:githubUser/gitprojectname.git=
  +
#VCS_GIT_BRANCH=origin/master=
  +
  +
# For SVN
  +
VCS_SVN_URL=https://svns.company.com/project/.../trunk/com.company.project=
  +
  +
</pre>

Revision as of 21:01, 31 March 2015

Under the L10n Streamlining directory (typically ~jenkins/Lingoport_Data/L10nStreamlining), each group file structure follows this pattern: 

<group_name>
├── config
│   ├── config_due_dates.xml
│   ├── config_file_cherry_picker.xml
│   ├── config_l10n_vendor.properties
│   ├── config_lingotek_locale_mapping.properties
│   ├── config_lrm_info.properties
│   └── config_pseudo_loc.xml
└── projects
    └── <project 1>
        ├── config
        │   ├── config_email_recipients.xml
        │   └── config_vcs.properties
        ...

Each of the group configuration files can be copied to the project 'config' directory is a project has a configuration different from most projects in that group. For more information on the group configuration files, visit the Group Configuration File page.

This section describes the configuration files for each project.

config_email_recipients.xml

The notification (email) mechanism uses this file to determine which emails are sent to what recipients.

The file is formatted this way: 

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<email-recipients>
        <notify-changes>
                <recipient>name1@company.com</recipient>
                <recipient>name2@company.com</recipient>
        </notify-changes>
        <prep-kit>
                <recipient>name@company.com</recipient>
        </prep-kit>
        <import-kit>
                <recipient>name1@company.com</recipient>
                <recipient>name2@company.com</recipient>
        </import-kit>
        <translators>
                <translator>name@company.com</translator>
        </translators>
        <l10nvendoradmins>
                <l10nvendoradmin>name@company.com</l10nvendoradmin>
        </l10nvendoradmins>
</email-recipients>

config_vcs.properties

This file tells what Version Control System to use and the URL of the repository project for checkin and checkout. A typical file looks like this: 

# Choices for VCS_TYPE are:
#    - git
#    - svn
VCS_TYPE=svn=

# For GIT:
# Uncomment the following and fill in the properties
#VCS_GIT_URL=git@github.com:githubUser/gitprojectname.git=
#VCS_GIT_BRANCH=origin/master=

# For SVN
VCS_SVN_URL=https://svns.company.com/project/.../trunk/com.company.project=
Retrieved from "http://wiki.lingoport.com/index.php?title=Project_Configuration_Files&oldid=86544"