Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinnZou authored Oct 27, 2023
1 parent 91b7c34 commit eb8a8a8
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,15 @@ Currently, the pipeline is configured to do 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`.

The pipeline is defined in [`.github/workflows/build.yml`](https://github.com/KevinnZou/compose-multiplatform-library-template/blob/feature/ci_support/.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`.

The pipeline is defined in [`.github/workflows/code_style.yml`](https://github.com/KevinnZou/compose-multiplatform-library-template/blob/feature/ci_support/.github/workflows/code_style.yml).

If the code style is not correct, you can run the following command to fix it:
```shell
./gradlew ktlintFormat
Expand All @@ -117,7 +120,8 @@ If the code style is not correct, you can run the following command to fix it:
### 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`.

The pipeline is defined in [`.github/workflows/wiki.yml`](https://github.com/KevinnZou/compose-multiplatform-library-template/blob/feature/ci_support/.github/workflows/wiki.yml).

## Set up the environment

Expand Down

0 comments on commit eb8a8a8

Please sign in to comment.