Use Github CI

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: Tests

on: push

jobs:

  test:

    name: Run tests

    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: Check

        run: ./gradlew check

      - name: Archive results

        uses: actions/upload-artifact@v2

        with:

          name: test-results

          path: build/reports

image: openjdk:latest

before_script:

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

cache:

  paths:

     - .gradle/

test:

  stage: test

  script:

    - ./gradlew check

  artifacts:

    paths:

      - build/reports/

pages:

  stage: deploy

  script:

    - ./gradlew dokkaHtml publishMavenPublicationToDav4jvmRepository

    - mkdir public && mv build/dokka public && mv build/repo public

  artifacts:

    paths:

      - public

  only:

    - master

[![Tests](https://github.com/bitfireAT/dav4jvm/actions/workflows/test.yml/badge.svg)](https://github.com/bitfireAT/dav4jvm/actions/workflows/test.yml)

[![License](https://img.shields.io/github/license/bitfireAT/dav4jvm)](https://github.com/bitfireAT/dav4jvm/blob/main/LICENSE)

[![JitPack](https://img.shields.io/jitpack/v/github/bitfireAT/dav4jvm)](https://jitpack.io/#bitfireAT/dav4jvm)

# dav4jvm

dav4jvm is a WebDAV/CalDAV/CardDAV library for JVM (Java/Kotlin). It has

been developed for [DAVx⁵](https://www.davx5.com) initially.

Repository: https://gitlab.com/bitfireAT/dav4jvm/

Repository: https://github.com/bitfireAT/dav4jvm/

(~~was: https://gitlab.com/bitfireAT/dav4jvm/~~)

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

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

Generated KDoc: https://bitfireAT.gitlab.io/dav4jvm/dokka/html/

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

We're happy about contributions, but please let us know in the discussions before. Then make the changes

in your own repository and send a pull request.

## How to use

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

You can use jitpack.io to include dav4jvm:

    allprojects {

        repositories {

        }

    }

    dependencies {

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

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

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

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

    }

dav4jvm needs a working XmlPullParser (XPP). On Android, the system already comes with

XPP and you don't need to include one; on other systems, you may need to

import for instance `org.ogce:xpp3` to get dav4jvm to work.

## Custom properties

If you use custom WebDAV properties, register the corresponding factories with `PropertyRegistery.register()`

If you use custom WebDAV properties, register the corresponding factories with `PropertyRegistry.register()`

before calling other dav4jvm methods.

dav4jvm is licensed under [Mozilla Public License, v. 2.0](LICENSE).

For questions, suggestions etc. use this forum:

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

If you want to contribute, please work in your own repository and then

send a merge request.

## Contributors

  * Ricki Hirner (initial contributor)

  * David González Verdugo (dgonzalez@owncloud.com)

  * Matt Jacobsen (https://gitlab.com/mattjacobsen)