Acime, the "Awesome CI server" is a small HTTP-server which builds Gradle projects and interacts with Github as a continuous integration server.
The system is documented in this README and should have fairly complete Javadoc strings. To build the documentation use:
gradle javadoc
The resulting documentation will be available in build/docs/javadoc/ as HTML files.
All dependencies are defined in the file build.gradle and will be automatically downloaded when built. The project uses JUnit for testing and Jetty as a HTTP server.
Ensure that Gradle (>= 5.1.1) and OpenJDK (>= 1.8) are installed and run the following instructions in your favourite terminal:
git clone
cd smallest-java-ci
gradle build
To start the server run
gradle run
and the server will be available at port 8080!
If you want to implement a new feature you probably want to add a new route. To do this alter the code in ContinuousIntegrationServer#handle similar to the way that the current code is.
We expect you to at least supply unit tests to any substantial changes to the codebase.
The structure of what you should do for a new feature looks like this:
- Make a new issue on Github
- Assign yourself to it
- Make a branch such as feat_issuenumber_shortdescription
- Commit your code with a message mentioning the issue number
- Open a pull request referencing the issue number
- Await code-review
- Set up Gradle, JUnit, Jetty, Servlets
- Wrote the HTTP routing
- Wrote the Gradle communication interface
- Wrote some JSON parsing and extraction (uses the Jetty JSON parser :-))
- Wrote the file system writer class
- Wrote some basic HTML generation for the indexes (to show a list of builds)
- Did some debugging of others code
- Did some code reviews
- Wrote this README (except the contributions)
- Write some HTTP requests (along with basic Github POSt request)
- Wrote Git Communication Interface
- Wrote most of Webhook Handler method which invokes the Git + Gradle interfaces
- Troubleshot + Debugged outstanding issues
- Did Code Reviews
- GitHub Status(notification)
- Mail module(Currently dead code, as GitHub status works)
- Wrote the file system reader class
- Wrote connection between HTML generation and file system reader
- Did code reviews
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent