Difference between revisions of "Globalyzer CLI for Continuous Globalization"
(→Introduction) |
(→Installation Components) |
||
| (22 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
= Introduction = |
= Introduction = |
||
| − | Globalyzer CLI can be deployed on a Continuous Globalization system. It |
+ | [[Terms_and_Definitions#GlobalyzerCLI|Globalyzer CLI]] can be deployed on a [[Terms_and_Definitions#ContinuousGlobalyization|Continuous Globalization]] system. It enables [[Terms_and_Definitions#i18n|i18n]] [[Terms_and_Definitions#scan|scanning]] of a project based on a Globalyzer <code>project.gproj</code> saved filed most likely at the top level directory of the source code; the results are then pushed to the [[Terms_and_Definitions#Dashboard|Dashboard]]. |
= Target User= |
= Target User= |
||
| + | The results are presented via the [[Terms_and_Definitions#Dashboard|Dashboard]] for any registered users, such as development team members, development management, [[Terms_and_Definitions#i18n|i18n]] specialists, [[Terms_and_Definitions#localization|L10n]] management, translators, QA, etc. |
||
| − | The typical Globalyzer Lite user is a developer working on a global market application. |
||
| + | |||
| + | The typical [[Terms_and_Definitions#GlobalyzerCLI|Globalyzer CLI]] <code>actor</code>is a [[Terms_and_Definitions#Jenkins|Jenkins]] system which automates the tasks of [[Terms_and_Definitions#scan|scanning]] and pushing the results to the Dashboard. |
||
= Typical Deployment = |
= Typical Deployment = |
||
| + | The Globalyzer client, including the Command Line Interface jar file, has been installed on the [[Terms_and_Definitions#ContinuousGlobalization|Continuous Globalization]] system, with a database to store the results of the scans. |
||
| − | Lite has been unzipped on the software developer's desktop and configured as an external tool in their IDE. The source code has a Globalyzer project definition file at the top level directory which specifies how the code should be scanned. The developer's desktop has access to the Globalyzer server |
||
| + | The source code may have a <code>project.gproj</code> file at the top level directory which specifies how the code should be scanned. |
||
| − | [[File: |
+ | [[File:CLI for CI.gif]] |
| + | |||
| + | <b>Note</b>: If you add LRM to this picture, the Continuous Globalization system needs to be a <b>Linux machine, preferably CentOS</b>. |
||
= Typical Workflow= |
= Typical Workflow= |
||
| + | [[Terms_and_Definitions#Jenkins|Jenkins]] uses the [[Terms_and_Definitions#GlobalyzerCLI|Globalyzer CLI]] via scripts to: |
||
| − | The developer uses to Lite within the IDE to: |
||
| + | * Get the code to be analyzed from a [[Terms_and_Definitions#repository|repository]] |
||
| − | * Scan the code being worked on for potential i18n issues before checking in the code to the source code repository |
||
| + | ** Optionally, import the [[Terms_and_Definitions#Globalyzerproject|Globalyzer project]] from the <code>project.gproj</code> file <i>if necessary</i>; The project may already exist in the database. |
||
| − | * refactors the code based on the checks |
||
| + | * Scan the code for potential [[Terms_and_Definitions#i18n|i18n]] issues |
||
| − | * pushes that code to the repository |
||
| + | * Push the results of the [[Terms_and_Definitions#scan|scan]] to the [[Terms_and_Definitions#Dashboard|Dashboard]] |
||
| + | |||
| + | |||
| + | This requires the [[Terms_and_Definitions#ruleset|rule sets]] used to scan the code have been vetted and the Globalyzer <code>project.gproj</code> file makes sense. |
||
| + | |||
| + | = Installation Components = |
||
| + | * The '''Globalyzer Server''' (System server) is hosted by Lingoport. If the Globalyzer Server is on site, a Linux machine is needed to be installed with Globalyzer Server. |
||
| + | * The '''Dashboard System''' and '''Continuous Globalization system''' is shown on different machines, although they could be one machine installed with the [[Terms_and_Definitions#stackinstaller|Stack Installer]] The [[Terms_and_Definitions#GlobalyzerCLI|Globalyzer CLI]] client is installed on the Continuous Globalization system to analyze code. |
||
| + | * The '''Developer Machine''' is not shown in this diagram. The developer will push source code to the repositories and may not have any Lingoport Software on their machine. |
||
| + | = Installation Notes = |
||
| − | This requires the rule sets used to scan the code have been vetted and the Globalyzer project definition file makes sense. |
||
| + | To install the Command Line Interface client (CLI), login to the Globalyzer server, download the Globalyzer Client installer for the platform you are running on, and run the installer. |
||
Latest revision as of 18:48, 30 December 2016
Contents
Introduction
Globalyzer CLI can be deployed on a Continuous Globalization system. It enables i18n scanning of a project based on a Globalyzer project.gproj saved filed most likely at the top level directory of the source code; the results are then pushed to the Dashboard.
Target User
The results are presented via the Dashboard for any registered users, such as development team members, development management, i18n specialists, L10n management, translators, QA, etc.
The typical Globalyzer CLI actoris a Jenkins system which automates the tasks of scanning and pushing the results to the Dashboard.
Typical Deployment
The Globalyzer client, including the Command Line Interface jar file, has been installed on the Continuous Globalization system, with a database to store the results of the scans.
The source code may have a project.gproj file at the top level directory which specifies how the code should be scanned.
Note: If you add LRM to this picture, the Continuous Globalization system needs to be a Linux machine, preferably CentOS.
Typical Workflow
Jenkins uses the Globalyzer CLI via scripts to:
- Get the code to be analyzed from a repository
- Optionally, import the Globalyzer project from the
project.gprojfile if necessary; The project may already exist in the database.
- Optionally, import the Globalyzer project from the
- Scan the code for potential i18n issues
- Push the results of the scan to the Dashboard
This requires the rule sets used to scan the code have been vetted and the Globalyzer project.gproj file makes sense.
Installation Components
- The Globalyzer Server (System server) is hosted by Lingoport. If the Globalyzer Server is on site, a Linux machine is needed to be installed with Globalyzer Server.
- The Dashboard System and Continuous Globalization system is shown on different machines, although they could be one machine installed with the Stack Installer The Globalyzer CLI client is installed on the Continuous Globalization system to analyze code.
- The Developer Machine is not shown in this diagram. The developer will push source code to the repositories and may not have any Lingoport Software on their machine.
Installation Notes
To install the Command Line Interface client (CLI), login to the Globalyzer server, download the Globalyzer Client installer for the platform you are running on, and run the installer.
