Move to Github

name: Build KDoc

on:

  push:

    branches: [main]

jobs:

  build:

    name: Build and publish KDoc

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

        with:

          submodules: true

      - uses: actions/setup-java@v2

        with:

          distribution: 'temurin'

          java-version: 11

          cache: 'gradle'

      - uses: gradle/wrapper-validation-action@v1

      - name: Build KDoc

        run: ./gradlew dokkaHtml

      - name: Publish KDoc

        if: success()

        uses: crazy-max/ghaction-github-pages@v2.5.0

        with:

          target_branch: gh-pages

          build_dir: build/dokka/html

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

name: Development tests

on: push

jobs:

  test:

    name: Tests without emulator

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

        with:

          submodules: true

      - uses: actions/setup-java@v2

        with:

          distribution: 'temurin'

          java-version: 11

          cache: 'gradle'

      - uses: gradle/wrapper-validation-action@v1

      - name: Run lint

        run: ./gradlew lintDebug

      - name: Run unit tests

        run: ./gradlew testDebugUnitTest

      - name: Archive results

        uses: actions/upload-artifact@v2

        with:

          name: test-results

          path: |

            build/outputs/lint*

            build/reports

  test_on_emulator:

    name: Tests with emulator

    runs-on: privileged

    container:

      image: ghcr.io/bitfireat/docker-android-ci:main

      options: --privileged

      env:

        ANDROID_HOME: /sdk

        ANDROID_AVD_HOME: /root/.android/avd

    steps:

      - uses: actions/checkout@v2

        with:

          submodules: true

      - uses: gradle/wrapper-validation-action@v1

      - name: Cache gradle dependencies

        uses: actions/cache@v2

        with:

          key: ${{ runner.os }}-1

          path: |

            ~/.gradle/caches

            ~/.gradle/wrapper

      - name: Start emulator

        run: start-emulator.sh

      - name: Run connected tests

        run: ./gradlew connectedDebugAndroidTest

      - name: Archive results

        uses: actions/upload-artifact@v2

        with:

          name: test-results

          path: |

            build/reports

image: registry.gitlab.com/bitfireat/docker-android-emulator:latest

before_script:

  - export GRADLE_USER_HOME=`pwd`/.gradle; chmod +x gradlew

cache:

  paths:

     - .gradle/

     - apk/

test:

  tags:

    - privileged

  script:

    - start-emulator.sh

    - mkdir -p apk

    - (cd apk && wget -q -O org.dmfs.tasks.apk https://f-droid.org/archive/org.dmfs.tasks_80800.apk && adb install org.dmfs.tasks.apk)

    - (cd apk && wget -q -O org.tasks.apk https://f-droid.org/archive/org.tasks_110701.apk && adb install org.tasks.apk)

    - ./gradlew check connectedCheck

  artifacts:

    paths:

      - build/outputs/lint-results-debug.html

      - build/reports/

pages:

  script:

    - ./gradlew dokka

    - mkdir public && mv build/dokka public

  artifacts:

    paths:

      - public

  only:

    - master

[![build status](https://gitlab.com/bitfireAT/ical4android/badges/master/build.svg)](https://gitlab.com/bitfireAT/ical4android/builds)

[![Development tests](https://github.com/bitfireAT/ical4android/actions/workflows/test-dev.yml/badge.svg)](https://github.com/bitfireAT/ical4android/actions/workflows/test-dev.yml)

[![Documentation](https://img.shields.io/badge/documentation-kdoc-brightgreen)](https://bitfireat.github.io/ical4android/)

# ical4android

* [DAVx⁵](https://www.davx5.com)

* [ICSx⁵](https://icsx5.bitfire.at)

and is currently used as git submodule.

Generated KDoc: https://bitfireat.github.io/ical4android/

For questions, suggestions etc. use [Github discussions](https://github.com/bitfireAT/ical4android/discussions).

We're happy about contributions! In case of bigger changes, please let us know in the discussions before.

Then make the changes in your own repository and send a pull request.

_This software is not affiliated to, nor has it been authorized, sponsored or otherwise approved

by Google LLC. Android is a trademark of Google LLC._

Generated KDoc: https://bitfireAT.gitlab.io/ical4android/dokka/ical4android/

Discussion: https://forums.bitfire.at/category/18/libraries

## How to use

You can use [jitpack.io to include ical4android](https://jitpack.io/#com.gitlab.bitfireAT/ical4android):

You can use ical4android as a git submodule or using [jitpack.io](https://jitpack.io/#bitfireAT/ical4android):

    allprojects {

        repositories {

        }

    }

    dependencies {

        implementation 'com.gitlab.bitfireAT:ical4android:<version>'  // see tags for latest version, like 1.0

        //implementation 'com.gitlab.bitfireAT:ical4android:master-SNAPSHOT'  // alternative

        implementation 'com.github.bitfireAT:ical4android:<version>'        // see tags for latest version, like 1.0, or use the latest commit ID from main branch

        //implementation 'com.github.bitfireAT:ical4android:main-SNAPSHOT'  // use it only for testing because it doesn't generate reproducible builds

    }

## Contact

```

bitfire web engineering – Stockmann, Hirner GesnbR

bitfire web engineering GmbH

Florastraße 27

2540 Bad Vöslau, AUSTRIA

```

Email: [play@bitfire.at](mailto:play@bitfire.at) (do not use this)

## License 

Copyright (C) bitfire web engineering (Ricki Hirner, Bernhard Stockmann) and contributors.

Copyright (C) Ricki Hirner and [contributors](https://github.com/bitfireAT/ical4android/graphs/contributors).

This program comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome

to redistribute it under the conditions of the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.html).