1.3.0

New Features

In this version, we set up the CI pipelines to keep enhancing the development experience. It mainly does three things:

Build the project

The pipeline is triggered on every push to the main branch or on every pull request.
It builds the project and runs the tests.

The pipeline is defined in .github/workflows/build.yml.

Check the code style

The pipeline is triggered on every push to the main branch or on every pull request.
It checks the code style and fails if the code style is not correct.

The pipeline is defined in .github/workflows/code_style.yml.

If the code style is not correct, you can run the following command to fix it:

./gradlew ktlintFormat

Publish the documentation

The pipeline is triggered on every push to the main branch or on every pull request.
It generates the documentation and publishes it to GitHub Pages.

The pipeline is defined in .github/workflows/wiki.yml.

What's Changed

• Basic CI setup by @KevinnZou in #2

Full Changelog: 1.2.0...1.3.0

1.2.0

New Features

• Support automatic code formatting using Ktlint.

This template applies the org.jlleitschuh.gradle.ktlint plugin to enforce the code style.
To check the code style, run the following command:

./gradlew ktlintCheck

To automatically fix the code style, run the following command:

./gradlew ktlintFormat

This template also setup the git hooks to fix the code style before committing automatically.
To install the git hooks, run the following command:

./gradlew setUpGitHooks

Then you can commit the code without worrying about the code style.

What's Changed

• Feature/ktlint support by @KevinnZou in #1

New Contributors

• @KevinnZou made their first contribution in #1

Full Changelog: 1.0.0...1.2.0

1.0.0

First stable version. Add support for automation documentation.

Instructions on setting up Github pages:

1. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.
2. In the "Code and automation" section of the sidebar, click Pages.
3. Under "Build and deployment", under "Source", select Deploy from a branch.
4. Under "Build and deployment", use the branch dropdown menu and select the branch gh-pages as publishing sources. This branch will be created and updated automatically by configured GitHub actions when there are changes on the main branch.
5. Click Save.

You can also refer to https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site for details.