Version | Number | Status |
---|---|---|
Spring Bot | (unreleased) | |
Symphony Java Toolkit |
Main Documentation
Please see the Github Pages site here: Spring Bot
Libraries
Chat Workflow
Chat Workflow provides interfaces, annotations and utilities for expressing bot workflows in Spring.
The Chat Workflow Symphony Starter implements this for symphony. It is intended that beyond configuration the developer will not have to understand any Symphony APIs to build work-flows and have them run in Symphony.
Chat Workflow Testing
Some useful functionality for testing your bots without having to integrate with Teams / Symphony.
Entity JSON
This is a utility that helps you serialize/deserialize JSON in a JSON format which contains enough information about java types to reconstruct objects.
Symphony BDK Chat Workflow Spring Boot Starter
- Allows Spring Bot to expose bots on Symphony. (see tutorial)
Teams Chat Workflow Spring Boot Starter
- Allows Spring Bot to expose bots on Microsoft Teams. (see tutorial)
Symphony Entities
- Java classes that can reconstruct Symphony classes such as HashTags, CashTags, Users etc.
Tools
All bots are deployed into maven central as executable jars.
Poll Bot
A bot for running polls in a Symphony chat room. Built using chat-workflow.
News (RSS) Bot
A bot for feeding news into a Symphony chat room. Built using chat-workflow.
Reminder Bot
Reads the contents of a room and creates reminders based on future events mentioned therein.
License
This project is licensed under the Apache 2.0 License.
Branches
There are two main branches:
spring-bot-master
: new code for the multi-platform Symphony / Microsoft Teams bot builder
symphony-java-toolkit-master
: legacy code for when this project only supported symphony.
Releasing This Project (For Maintainers)
In order to do a release:
- Changes.md
- Update this file to include details of the release.
- On Releaser's machine:
mvn clean test -P symphony-ci
mvn versions:set -DnewVersion=<our breaking change no>.<minor version no>.<our-patch-version-no> -DartifactId=\* -DgroupId=\*
mvn -DskipTests clean test source:jar javadoc:javadoc deploy -P symphony-release
mvn versions:set -DnewVersion=<our breaking change no>.<symphony-api-version>.<our-release-no+1>-SNAPSHOT -DartifactId=\* -DgroupId=\*
# then push to git
- On
oss.sonatype.org
- Close the Staging Repository
- Release it.
- Perform release on github with same number