Merge pull request #51 from ical4j/feature/refactor

Prepare 2.0.0 release

.env

@@ -0,0 +1,4 @@
+CHANGELOG_START_TAG=ical4j-connector-2.0.0-alpha2
+CHANGELOG_END_TAG=HEAD
+
+GRADLE_VERSION=7.6

.github/workflows/build.yml

@@ -13,14 +13,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-java@v1
-      with:
-        java-version: 11
-#    - name: Grant execute permission for gradlew
-#      run: chmod +x gradlew
-    - name: Build with Gradle
-#      run: ./gradlew build
-      uses: eskatos/gradle-command-action@v1
-      with:
-        arguments: build
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: 11
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Execute Gradle build
+        run: ./gradlew check --console=plain --warning-mode all

.github/workflows/publish-snapshots.yml

@@ -1,22 +1,54 @@
 name: Publish snapshots
 
-on: [push]
+on:
+  push:
+    branches:
+      - 'develop'
+      - 'feature/refactor'
 
 permissions: read-all
 
 jobs:
   gradle:
+    name: Test with Java ${{ matrix.jdk }}
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        jdk: [ '11', '17', '19' ]
+
     steps:
-    - uses: actions/checkout@v1
-    - uses: actions/setup-java@v1
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Set up JDK ${{ matrix.jdk }}
+      uses: actions/setup-java@v1
       with:
-        java-version: 11
+        java-version: ${{ matrix.jdk }}
     - uses: eskatos/gradle-command-action@v1
       with:
-        arguments: build -x test publish
-      env:
-        GPR_USERNAME: benfortuna
-        GPR_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
-        MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+        arguments: check -x test --console=plain --warning-mode all
+
+  publish:
+    name: Publish Artifact
+    needs: gradle
+    if: ${{ needs.gradle.result == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: 11
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Execute Gradle build
+        run: ./gradlew build -x test publish
+        env:
+          GPR_USERNAME: benfortuna
+          GPR_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MAVEN_USERNAME: ${{ secrets.OSS_SONATYPE_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.OSS_SONATYPE_PASSWORD }}

.gitignore

@@ -2,5 +2,7 @@
 ical4j-connector.iml
 build
 .gradle
+.jpb
 out
 target
+ical-local

Makefile

@@ -0,0 +1,53 @@
+SHELL:=/bin/bash
+include .env
+
+NEXT_VERSION=$(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
+CHANGE_JUSTIFICATION=$(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
+
+.PHONY: all gradlew clean check build changelog currentVersion markNextVersion listApiChanges approveApiChanges \
+	verify release publish
+
+all: check
+
+gradlew:
+	./gradlew wrapper --gradle-version=$(GRADLE_VERSION) --distribution-type=bin
+
+clean:
+	./gradlew clean
+
+check:
+	./gradlew check
+
+test:
+	./gradlew test
+
+build:
+	./gradlew build
+
+changelog:
+	git log "$(CHANGELOG_START_TAG)...$(CHANGELOG_END_TAG)" \
+    	--pretty=format:'* %s [View commit](http://github.com/ical4j/ical4j-connector/commit/%H)' --reverse | grep -v Merge
+
+currentVersion:
+	./gradlew -q currentVersion
+
+markNextVersion:
+	./gradlew markNextVersion -Prelease.version=$(NEXT_VERSION)
+
+listApiChanges:
+	./gradlew revapi
+
+approveApiChanges:
+	./gradlew :revapiAcceptAllBreaks --justification $(CHANGE_JUSTIFICATION)
+
+install:
+	./gradlew publishToMavenLocal
+
+verify:
+	./gradlew verify
+
+release: verify
+	./gradlew release
+
+publish:
+	./gradlew publish

README.md

@@ -1,10 +1,33 @@
-[![Build Status](https://drone.io/github.com/ical4j/ical4j-connector/status.png)](https://drone.io/github.com/ical4j/ical4j-connector/latest)
+[Jackrabbit WebDAV]: https://jackrabbit.apache.org/jcr/components/jackrabbit-webdav-library.html
+[DAVResource]: https://jackrabbit.apache.org/api/trunk/org/apache/jackrabbit/webdav/DavResource.html
 
-==================================
- iCal4j Connector - Release Notes
-==================================
+# iCal4j Connector
 
- Support for iCalendar CalDAV/CardDAV specifications. See the website for details:
-
- 	http://ical4j.github.io/docs/ical4j-connector
-
+A client library with support for various iCalendar servers, including support for CalDAV.
+
+## Overview
+
+This library provides client support for backend calendar services using the iCal4j object model. The
+most popular services implement DAV extensions for Calendaring (CalDAV) and VCard (CardDAV).
+
+Please see specific subprojects for implementation documentation.
+
+## Setup
+
+TBD.
+
+## Usage
+
+TBD.
+
+## References
+
+* [RFC3744](https://datatracker.ietf.org/doc/html/rfc3744) (WebDAV Access Control Protocol)
+* [RFC4331](https://www.rfc-editor.org/rfc/rfc4331.html) (Quota and size properties for DAV)
+* [RFC4791](https://www.rfc-editor.org/rfc/rfc4791.html) (CalDAV)
+* [RFC4918](https://www.rfc-editor.org/rfc/rfc4918.html) (WebDAV)
+* [RFC5397](https://www.rfc-editor.org/rfc/rfc5397.html) (WebDAV Current Principal Extension)
+* [RFC5545](https://tools.ietf.org/html/rfc5545) (iCalendar)
+* [RFC6350](https://datatracker.ietf.org/doc/html/rfc6350) (vCard)
+* [RFC6352](https://www.rfc-editor.org/rfc/rfc6352.html) (CardDAV)
+* [RFC7953](https://datatracker.ietf.org/doc/html/rfc7953) (iCalendar Availability)