spring statemachine
4.0.0
This document provides an overview of the Spring Statemachine project, including its goals, code of conduct, artifact downloading, documentation, samples, building from source, contributing guidelines, and license information. The project aims to offer a standardized infrastructure for managing state machine concepts within Spring applications. Refer to the project page for the latest release information, as the default branch might be unstable.
Spring Statemachine
(GitHub default)
The Spring Statemachine project aims to provide a common infrastructure
to work with state machine concepts in Spring applications.
It is advised to check the actual state of this project by referring to
the latest releases found on
Spring
Statemachine Project Page.
The git repo default branch may be relatively unstable when new features are
added into the source code.
Code of Conduct
This project adheres to the Contributor Covenant
code of conduct.
By participating, you are expected to uphold this code. Please report
unacceptable behavior to [email protected].
Downloading Artifacts
See
downloading
Spring artifacts for Maven repository information.
Documentation
The Spring
Statemachine Project Page contains links to currently available
JavaDoc and Reference Documentation for particular releases and
versions.
Samples
Samples can be found under spring-statemachine-samples. Check
the reference documentation more about what those do.
Building from Source
Spring Statemachine uses a Gradle-based build
system.
In the instructions below, ./gradlew is
invoked from the root of the source tree and serves as
a cross-platform, self-contained bootstrap mechanism for the build.
Prerequisites
Git and the
JDK8 build.
Be sure that your JAVA_HOME environment variable points to the
jdk folder extracted from the JDK download. While build requires
JDK8, created artifacts are JDK7 compatible.
Check out sources
Install all spring-* jars into your local Maven cache
Compile and test; build all jars, distribution zips, and docs
Discover more commands with ./gradlew tasks.
See also the
Gradle
build and release FAQ.
Contributing
Pull requests are welcome;
see the
contributor
guidelines for details.
If you want to contribute, search github tickets marked with help
wanted or come up with your own ticket but please first open a ticket
to discuss in order to avoid duplicate work on a topic or issue. Nobody
wants to see the same work done twice!
License
Spring Statemachine is Open Source software released under the
Apache 2.0 license.
