/tycho-rules

:ok_hand: Check your architecture on big tycho projects

Primary LanguageJavaEclipse Public License 2.0EPL-2.0

tycho-rules

A Maven/Tycho project to add some validation rules for OSGI development. Most of the rules are pretty simple and are used to maintain coherence in a multi-plugin project.

Status

Codeship Status for bmaggi/tycho-rules License Maven Central

How to build

This project is built using Maven. To build locally, simply execute the command line:

mvn clean install

You can also chose the it test with this command

mvn invoker:run -Dinvoker.test=checkexportpackage,checkexportpackage.failing

How to use

Configuration to add in the pom.xml of your project:

<build>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-enforcer-plugin</artifactId>
			<version>${enforcer.api.version}</version>
			<dependencies>
				<dependency>
					<groupId>com.github.bmaggi.checks</groupId>
					<artifactId>tycho-rules</artifactId>
					<version>0.1.3</version>
				</dependency>
			</dependencies>
			<executions>
				<execution>
					<id>custom-enforce</id>
					<phase>validate</phase>
					<goals>
						<goal>enforce</goal>
					</goals>
					<configuration>
						<rules>
						<!-- define your rules here see Rules.md -->
						</rules>
					</configuration>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>