MVN Plugin - Revision history

MaryH at 23:29, 23 March 2018

2018-03-23T23:29:05Z

← Older revision		Revision as of 23:29, 23 March 2018
Line 13:		Line 13:

	The MVN plugin can be downloaded from the Client Download Page on the Globalyzer Server.		The MVN plugin can be downloaded from the Client Download Page on the Globalyzer Server.
	The file name is globalyzer-maven-plugin-x.y.z.jar where x.y.z is the version for the plugin, for instance 5.3.0. We ask that this jar file be installed in a private MVN repository at the customer's site.		The file name is globalyzer-maven-plugin-x.y.z_#.jar where x.y.z_# is the version (including build number) for the plugin, for instance 6.1.0_22. We ask that this jar file be installed in a private MVN repository at the customer's site.

	For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for version <code>5.3.0</code> of the MVN plugin. The same applies to other versions.		For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for version <code>6.1.0</code> of the MVN plugin. The same applies to other versions.

	C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:/Path/to/the/plugin/jarfile/'''globalyzer-maven-plugin-5.3.0.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.3.0''' -Dpackaging='''maven-plugin'''		C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:/Path/to/the/plugin/jarfile/'''globalyzer-maven-plugin-6.1.0_22.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''6.1.0''' -Dpackaging='''maven-plugin'''
	[INFO] Scanning for projects...		[INFO] Scanning for projects...
	[INFO]		[INFO]
Line 25:		Line 25:
	[INFO]		[INFO]
	[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---		[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---
	[INFO] Installing C:\Linternal\Installers\install\globalyzer-maven-plugin-5.3.0.jar to C:\Users\Yourname\.m2\repository\com\lingoport\globalyzer\client\maven\globalyzer-maven-plugin\5.3.0\globalyzer-maven-plugin-5.3.0.jar		[INFO] Installing C:\Linternal\Installers\install\globalyzer-maven-plugin-6.1.0_22.jar to C:\Users\Yourname\.m2\repository\com\lingoport\globalyzer\client\maven\globalyzer-maven-plugin\6.1.0\globalyzer-maven-plugin-6.1.0_22.jar
	[INFO] ------------------------------------------------------------------------		[INFO] ------------------------------------------------------------------------
	[INFO] BUILD SUCCESS		[INFO] BUILD SUCCESS
Line 40:		Line 40:
	<groupId>com.lingoport.globalyzer.client.maven</groupId>		<groupId>com.lingoport.globalyzer.client.maven</groupId>
	<artifactId>globalyzer-maven-plugin</artifactId>		<artifactId>globalyzer-maven-plugin</artifactId>
	<version>5.3.0</version>		<version>6.1.0</version>
	<configuration>		<configuration>
	'''-required - '''		'''-required - '''
Line 107:		Line 107:
	<groupId>com.lingoport.globalyzer.client.maven</groupId>		<groupId>com.lingoport.globalyzer.client.maven</groupId>
	<artifactId>globalyzer-maven-plugin</artifactId>		<artifactId>globalyzer-maven-plugin</artifactId>
	<version>5.3.0</version>		<version>6.1.0</version>
	<executions>		<executions>
	<execution>		<execution>

MaryH: /* Running Globalyzer MVN Plugin From The Command Prompt / Shell */

2018-03-23T23:24:57Z

Running Globalyzer MVN Plugin From The Command Prompt / Shell

← Older revision		Revision as of 23:24, 23 March 2018
Line 86:		Line 86:
	Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:		Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:

	<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.3.0:scan</code>		<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:6.1.0:scan</code>

	After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.		After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.

Lcameron at 18:03, 17 November 2016

2016-11-17T18:03:56Z

← Older revision		Revision as of 18:03, 17 November 2016
Line 78:		Line 78:
	* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j <b>configuration</b> file to use if <code>setLog4jProperties</code> is set to true. For example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.		* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j <b>configuration</b> file to use if <code>setLog4jProperties</code> is set to true. For example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.
	* Best would be to have the <b>exact same configuration</b> for all Globalyzer goals to make sure one configuration is not taking over the other ones.		* Best would be to have the <b>exact same configuration</b> for all Globalyzer goals to make sure one configuration is not taking over the other ones.
	* By default, <code>enhancedScanning</code> takes place. However, this detailed scanning takes a lot		* By default, <code>enhancedScanning</code> takes place. However, this detailed scanning takes a lot of memory. If you find that you are running out of memory when scanning, try setting this to false.
	of memory. If you find that you are running out of memory when scanning, try setting this to false.		* By default, <code>clearCache</code> is set to false. This attribute only makes sense if <code>enhancedScanning</code> is set to true. It's a way to try to reduce the amount of memory used when performing detailed scanning.
	* By default, <code>clearCache</code> is set to false. This attribute only makes sense if
	<code>enhancedScanning</code> is set to true. It's a way to try to reduce the amount of memory used
	when performing detailed scanning.

Lcameron at 17:59, 17 November 2016

2016-11-17T17:59:40Z

← Older revision		Revision as of 17:59, 17 November 2016
Line 1:		Line 1:
	Globalyzer has a number of clients: The Workbench, the command line interface, Lite, the Ant client, and the MVN plugin. When using a MVN project, you can add code scanning with Globalyzer using our MVN plugin.		Globalyzer has a number of clients: The Workbench, the command line interface, Lite, the Ant client, and the MVN plugin. When using a MVN project, you can add code scanning with Globalyzer using our MVN plugin.
	It is well suited for use within automation routines and Continuous Integration (CI) systems as well as within a typical developer environment, for instance within an Integrated Development Environments (IDEs).		It is well suited for use within automation routines and Continuous Integration (CI) systems as well as within a typical developer environment, for instance within Integrated Development Environments (IDEs).

	The Globalyzer MVN plugin generates scan reports to a directory specified the pom.xml file. Scan reports are available in a variety of formats. We ask our MVN customers to install the MVN plugin in a private MVN repository for that company.		The Globalyzer MVN plugin generates scan reports to a directory specified in the pom.xml file. Scan reports are available in a variety of formats. We ask our MVN customers to install the MVN plugin in a private MVN repository for that company.

	The steps to use the Globalyzer MVN plugin are the same as any MVN plugin:		The steps to use the Globalyzer MVN plugin are the same as any MVN plugin:
Line 12:		Line 12:
	== Install the Globalyzer MVN Plugin ==		== Install the Globalyzer MVN Plugin ==

	~~For those customers who require the~~ MVN plugin~~, we make~~ the globalyzer-maven-plugin-x.y.z~~-jar-with-dependencies~~.jar ~~file available for download~~ where x.y.z is the version for the plugin, for instance 5.2.1. We ask that this jar file be installed in a private MVN repository at the customer's ~~side.~~		The MVN plugin can be downloaded from the Client Download Page on the Globalyzer Server.
	~~You first need to get the file from a secure FTP location, which will be sent to customers who request it~~. ~~Lingoport customers can request the MVN plugin by sending an email to <code>support at lingoport dot com</code>~~		The file name is globalyzer-maven-plugin-x.y.z.jar where x.y.z is the version for the plugin, for instance 5.3.0. We ask that this jar file be installed in a private MVN repository at the customer's site.

	For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for a version <code>5.3.0</code> of the MVN plugin. The same applies to other versions.		For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for version <code>5.3.0</code> of the MVN plugin. The same applies to other versions.

	C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:\Path\to\the\plugin\jarfile\'''globalyzer-maven-plugin-5.3.0~~-jar-with-dependencies~~.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.3.0''' -Dpackaging='''maven-plugin'''		C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:/Path/to/the/plugin/jarfile/'''globalyzer-maven-plugin-5.3.0.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.3.0''' -Dpackaging='''maven-plugin'''
	[INFO] Scanning for projects...		[INFO] Scanning for projects...
	[INFO]		[INFO]
Line 76:		Line 76:
	Notes:		Notes:
	* The <b><code>session level settings </code></b> are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans		* The <b><code>session level settings </code></b> are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans
	* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j <b>configuration</b> file to use ~~is the~~ <code>setLog4jProperties/code> is set to true. For ~~for~~ example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.		* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j <b>configuration</b> file to use if <code>setLog4jProperties</code> is set to true. For example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.
	* Best would be to have the <b>exact same configuration</b> for all Globalyzer goals to make sure one configuration is not taking over the other ones.		* Best would be to have the <b>exact same configuration</b> for all Globalyzer goals to make sure one configuration is not taking over the other ones.
			* By default, <code>enhancedScanning</code> takes place. However, this detailed scanning takes a lot
			of memory. If you find that you are running out of memory when scanning, try setting this to false.
			* By default, <code>clearCache</code> is set to false. This attribute only makes sense if
			<code>enhancedScanning</code> is set to true. It's a way to try to reduce the amount of memory used
			when performing detailed scanning.


	== Running Globalyzer MVN Plugin From The Command Prompt / Shell ==		== Running Globalyzer MVN Plugin From The Command Prompt / Shell ==

Lcameron at 19:37, 16 November 2016

2016-11-16T19:37:53Z

← Older revision		Revision as of 19:37, 16 November 2016
Line 12:		Line 12:
	== Install the Globalyzer MVN Plugin ==		== Install the Globalyzer MVN Plugin ==

	For those customers who require the MVN plugin, we make the globalyzer-maven-plugin-x.y.z-jar-with-dependencies.jar file available for ~~downloadm~~ where x.y.z is the version for the plugin, for instance 5.2.1. We ask that this jar file be installed in a private MVN repository at the customer's side.		For those customers who require the MVN plugin, we make the globalyzer-maven-plugin-x.y.z-jar-with-dependencies.jar file available for download where x.y.z is the version for the plugin, for instance 5.2.1. We ask that this jar file be installed in a private MVN repository at the customer's side.
	You first need to get the file from a secure FTP location, which will be sent to customers who request it. Lingoport customers can request the MVN plugin by sending an email to <code>support at lingoport dot com</code>		You first need to get the file from a secure FTP location, which will be sent to customers who request it. Lingoport customers can request the MVN plugin by sending an email to <code>support at lingoport dot com</code>

	For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for a version <code>5.2.1</code> of the MVN plugin. The same applies to other versions.t		For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for a version <code>5.3.0</code> of the MVN plugin. The same applies to other versions.

	C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:\Path\to\the\plugin\jarfile\'''globalyzer-maven-plugin-5.2.1-jar-with-dependencies.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.2.1''' -Dpackaging='''maven-plugin'''		C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:\Path\to\the\plugin\jarfile\'''globalyzer-maven-plugin-5.3.0-jar-with-dependencies.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.3.0''' -Dpackaging='''maven-plugin'''
	[INFO] Scanning for projects...		[INFO] Scanning for projects...
	[INFO]		[INFO]
Line 25:		Line 25:
	[INFO]		[INFO]
	[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---		[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---
	[INFO] Installing C:\Linternal\Installers\install\globalyzer-maven-plugin-5.2.1.jar to C:\Users\Yourname\.m2\repository\com\lingoport\globalyzer\client\maven\globalyzer-maven-plugin\5.2.1\globalyzer-maven-plugin-5.2.1.jar		[INFO] Installing C:\Linternal\Installers\install\globalyzer-maven-plugin-5.3.0.jar to C:\Users\Yourname\.m2\repository\com\lingoport\globalyzer\client\maven\globalyzer-maven-plugin\5.3.0\globalyzer-maven-plugin-5.3.0.jar
	[INFO] ------------------------------------------------------------------------		[INFO] ------------------------------------------------------------------------
	[INFO] BUILD SUCCESS		[INFO] BUILD SUCCESS
Line 40:		Line 40:
	<groupId>com.lingoport.globalyzer.client.maven</groupId>		<groupId>com.lingoport.globalyzer.client.maven</groupId>
	<artifactId>globalyzer-maven-plugin</artifactId>		<artifactId>globalyzer-maven-plugin</artifactId>
	<version>5.2.1</version>		<version>5.3.0</version>
	<configuration>		<configuration>
	'''-required - '''		'''-required - '''
Line 83:		Line 83:
	Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:		Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:

	<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan</code>		<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.3.0:scan</code>

	After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.		After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.
Line 95:		Line 95:

	== Multi-Threaded Support ==		== Multi-Threaded Support ==
	The Globalyzer MVN plugin ~~supports~~ multi-threaded invocation. ~~For instance, on multi-module projects, use the -T option. For instance:~~		The Globalyzer MVN plugin does not support multi-threaded invocation.

	~~<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan -Pglobalyzer -T1.0C</code>~~


	~~If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:~~

	~~<code>mvn validate -T1.0C</code>~~

	~~(See the multi-scan example below)~~

	== Multi-Scan Projects ==		== Multi-Scan Projects ==
Line 113:		Line 104:
	<groupId>com.lingoport.globalyzer.client.maven</groupId>		<groupId>com.lingoport.globalyzer.client.maven</groupId>
	<artifactId>globalyzer-maven-plugin</artifactId>		<artifactId>globalyzer-maven-plugin</artifactId>
	<version>5.2.1</version>		<version>5.3.0</version>
	<executions>		<executions>
	<execution>		<execution>

Lcameron at 18:35, 16 November 2016

2016-11-16T18:35:34Z

← Older revision		Revision as of 18:35, 16 November 2016
Line 57:		Line 57:
	<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )		<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )
	<enhancedScanning></enhancedScanning> ( default: true )		<enhancedScanning></enhancedScanning> ( default: true )
	<clearCache></clearCache> ( default: false)		<clearCache></clearCache> ( default: false )
	'''- scan level settings -'''		'''- scan level settings -'''
	<projectName></projectName> ( default: project artifact )		<projectName></projectName> ( default: project artifact )

Lcameron at 18:34, 16 November 2016

2016-11-16T18:34:45Z

← Older revision		Revision as of 18:34, 16 November 2016
Line 55:		Line 55:
	<filterWithDictionary></filterWithDictionary> ( default: true )		<filterWithDictionary></filterWithDictionary> ( default: true )
	<setLog4jProperties></setLog4jProperties> ( default: true )		<setLog4jProperties></setLog4jProperties> ( default: true )
	<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )		<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )
			<enhancedScanning></enhancedScanning> ( default: true )
			<clearCache></clearCache> ( default: false)
	'''- scan level settings -'''		'''- scan level settings -'''
	<projectName></projectName> ( default: project artifact )		<projectName></projectName> ( default: project artifact )

Olibouban: /* Configure the Globalyzer MVN Plugin */

2016-09-27T22:27:59Z

Configure the Globalyzer MVN Plugin

← Older revision		Revision as of 22:27, 27 September 2016
Line 73:		Line 73:

	Notes:		Notes:
	* The session level settings are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans		* The <b><code>session level settings </code></b> are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans
	* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j <b>configuration</b> file to use is the <code>setLog4jProperties/code> is set to true. For for example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.		* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j <b>configuration</b> file to use is the <code>setLog4jProperties/code> is set to true. For for example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.
	* Best would be to have the <b>exact same configuration</b> for all Globalyzer goals to make sure one configuration is not taking over the other ones.		* Best would be to have the <b>exact same configuration</b> for all Globalyzer goals to make sure one configuration is not taking over the other ones.

Mheilner at 18:28, 27 September 2016

2016-09-27T18:28:03Z

← Older revision		Revision as of 18:28, 27 September 2016
Line 68:		Line 68:
	<!-- ScanSummaryText -->		<!-- ScanSummaryText -->
	<reportType></reportType> ( default: ScanDetailedXML )		<reportType></reportType> ( default: ScanDetailedXML )
	<reportPath></reportPath> ( default: target/i18n )		<reportPath></reportPath> ( default: target/i18n )

	</configuration>		</configuration>
	</plugin>		</plugin>

Mheilner at 18:27, 27 September 2016

2016-09-27T18:27:35Z

← Older revision		Revision as of 18:27, 27 September 2016
Line 74:		Line 74:

	Notes:		Notes:
	* The ~~configuration~~ settings are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans		* The session level settings are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans
	* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j <b>configuration</b> file to use is the <code>setLog4jProperties/code> is set to true. For for example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.		* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j <b>configuration</b> file to use is the <code>setLog4jProperties/code> is set to true. For for example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.
	* Best would be to have the <b>exact same configuration</b> for all Globalyzer goals to make sure one configuration is not taking over the other ones.		* Best would be to have the <b>exact same configuration</b> for all Globalyzer goals to make sure one configuration is not taking over the other ones.