/spring-boot-agent

Atomist Spring Boot application agent

Primary LanguageJavaApache License 2.0Apache-2.0

Atomist spring-boot-agent

Download

An agent that sends events for Spring Boot applications to Atomist.

Learn more about automating software delivery at the Atomist web site. Detailed information is available in the Atomist Documentation.

Configuration

To make proper use of the agent, you must have created an Atomist workspace.

Then you can drop the Agent in your application by adding the following to your pom.xml:

<project>
	...
	<dependencies>
		...
		<dependency>
			<groupId>com.atomist</groupId>
			<artifactId>spring-boot-agent</artifactId>
			<version>VERSION_RANGE</version>
		</dependency>
	</dependencies>
</project>

If you are using a Spring Boot 2 release, replace VERSION_RANGE with [2.0.0,3.0.0). If you are using a Spring Boot 1 release, replace VERSION_RANGE with [1.0.0,2.0.0).

As this agent is not available from Maven Central adding the following repo is requried, too:

<project>
	...
	<repositories>
		...
		<repository>
			<snapshots>
				<enabled>false</enabled>
			</snapshots>
			<id>bintray-atomist-atomist</id>
			<name>bintray</name>
			<url>https://dl.bintray.com/atomist/atomist</url>
		</repository>
	</repositories>
</project>

Once add to your project, the agent can be configured from the Spring Boot application.yml or application.properties:

# enable or disable the agent
atomist.enabled=true
# enable trace output; this allows you to review the event messages the agent will send
atomist.debug=false
# configure the endpoint; {id} should be replaced by your Atomist workspace ID
atomist.url=https://webhook.atomist.com/atomist/application/teams/{id}

# use the following keys to send some information about your environment to Atomist
atomist.environment.domain=
atomist.environment.<any>=

Support

General support questions should be discussed in the #support channel in the Atomist community Slack workspace.

If you find a problem, please create an issue.

Contributing

If you are interested in contributing to the Atomist open source projects, please see our contributing guidelines and our code of conduct.


Created by Atomist. Need Help? Join our Slack workspace.