General

Welcome to the Swingletree documentation.

Please use the navigation to left to pick a section of your interest.

Swingletree Workflow

The tools of a CI build often produce machine-readable reports. These reports can be consumed by a plugin provided by Swingletree.

Some plugins (like plugin-sonarqube or plugin-nebula) send their build report directly to Swingletree. You will need a Build UID attached to the reports to identify the build run (the UID can be retrieved using yoke).

Yoke simpifies collecting and sending reports to Swingletree. It can be used to send report files generated by the current build.

graph TD subgraph CI Build A(Report A) B(Report B) C(Report C) tool(CI/CD Tool) yoke[yoke cli] end gh(SCM Provider) elastic(ElasticSearch) subgraph Swingletree gate plugin scotty end yoke --collect--> A yoke --collect--> B yoke --collect--> C yoke --report--> gate tool --report--> gate gate --routes--> plugin plugin --> scotty scotty --> gh scotty --> elastic

Swingletree processes the reports and attaches the information to the commits in GitHub. It also persists the report data to ElasticSearch, if the History-Feature is enabled.