Skip to content

Commit da54f56

Browse files
committed
docs: add net.sf.ucanaccess migration guide, fix CI badges, sharpen POM description
- Add section "Migrating from net.sf.ucanaccess" explaining the drop-in dependency-coordinate switch, and link to it from "Why this Fork?" as a call to action for maintainers of dependent projects. - Fix README build badges pointing to the now-removed ci_jdk11_ubuntu.yml/ci_jdk11_win.yml workflow files; point to the consolidated ci.yml and add a CodeQL status badge. - Rework the POM description to mention it's a maintained fork of the unmaintained net.sf.ucanaccess project
1 parent 406f852 commit da54f56

2 files changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<img src="https://img.shields.io/maven-central/last-update/io.github.spannm/ucanaccess?label=Updated&style=flat-square&color=blue" alt="Maven Central Last Update">
44
<a href="https://github.com/spannm/ucanaccess/stargazers"><img src="https://img.shields.io/github/stars/spannm/ucanaccess?logo=github&label=&logoColor=white&labelColor=555555&color=007ec6&style=flat-square" alt="GitHub Stars"></a>
55
<br>
6-
<a href="https://github.com/spannm/ucanaccess/actions/workflows/ci_jdk11_ubuntu.yml"><img src="https://img.shields.io/github/actions/workflow/status/spannm/ucanaccess/ci_jdk11_ubuntu.yml?label=Build%20(JDK%2011%20Linux)&style=flat-square" alt="GitHub Actions Workflow Status"></a>
7-
<a href="https://github.com/spannm/ucanaccess/actions/workflows/ci_jdk11_win.yml"><img src="https://img.shields.io/github/actions/workflow/status/spannm/ucanaccess/ci_jdk11_win.yml?label=Build%20(JDK%2011%20Win)&style=flat-square" alt="GitHub Actions Workflow Status"></a>
6+
<a href="https://github.com/spannm/ucanaccess/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/spannm/ucanaccess/ci.yml?label=Build&style=flat-square" alt="GitHub Actions Workflow Status"></a>
7+
<a href="https://github.com/spannm/ucanaccess/actions/workflows/codeql.yml"><img src="https://img.shields.io/github/actions/workflow/status/spannm/ucanaccess/codeql.yml?label=CodeQL&style=flat-square" alt="CodeQL Workflow Status"></a>
88
<a href="https://javadoc.io/doc/io.github.spannm/ucanaccess"><img src="https://javadoc.io/badge2/io.github.spannm/ucanaccess/javadoc.svg?style=flat-square" alt="Javadoc"></a>
99
<a href="https://apidia.net/mvn/io.github.spannm/ucanaccess"><img src="https://apidia.net/mvn/io.github.spannm/ucanaccess/badge_flat_square.svg" alt="APIdia"></a>
1010
</div>
@@ -81,6 +81,22 @@ implementation("io.github.spannm:ucanaccess:5.1.7")
8181

8282
<p style="height: 20px;">&nbsp;</p>
8383

84+
## 🔁 Migrating from `net.sf.ucanaccess`
85+
86+
Still on the original `net.sf.ucanaccess:ucanaccess` artifact? That project has had no release since 2020 and no longer receives security or compatibility updates. Switching to this fork is a **drop-in, API-compatible change** — no code changes required, just update your dependency coordinates:
87+
88+
```diff
89+
- <groupId>net.sf.ucanaccess</groupId>
90+
+ <groupId>io.github.spannm</groupId>
91+
<artifactId>ucanaccess</artifactId>
92+
- <version>5.0.1</version>
93+
+ <version>5.1.7</version>
94+
```
95+
96+
You get current Jackcess/HSQLDB versions (with their CVE fixes), tested Java 11/17/21 support on Linux and Windows, and active maintenance — with the same JDBC driver class and connection URL you already use.
97+
98+
<p style="height: 20px;">&nbsp;</p>
99+
84100
## 🚦 Quick Start
85101

86102
Connecting to your database is as simple as:
@@ -99,10 +115,10 @@ try (Connection conn = DriverManager.getConnection(url)) {
99115

100116
## ❤️ Why this Fork?
101117

102-
The original project (developed by Marco Amadei and Gord Thompson) was the gold standard for Access connectivity but went quiet in 2020.
118+
The original project (developed by Marco Amadei and Gord Thompson) was the gold standard for Access connectivity but went quiet in 2020, leaving `net.sf.ucanaccess:ucanaccess` unmaintained at version 5.0.1.
103119
As a long-time contributor and Java enthusiast, I decided to give UCanAccess a **new home**.
104120

105-
My goal is to keep this essential tool alive, maintain a **high test coverage** (JUnit 5), and ensure it meets modern **Clean Code** and **SOLID** standards.
121+
My goal is to keep this essential tool alive, maintain a **high test coverage** (JUnit 5), and ensure it meets modern **Clean Code** and **SOLID** standards. If you maintain a project that still depends on `net.sf.ucanaccess`, see [Migrating from `net.sf.ucanaccess`](#-migrating-from-netsfucanaccess) above — a PR bumping the dependency is very welcome.
106122

107123
<p style="height: 20px;">&nbsp;</p>
108124

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<packaging>jar</packaging>
1515

1616
<name>UCanAccess</name>
17-
<description>Open-source pure Java JDBC driver for Access databases. Allows Java developers and client programs (e.g. OpenOffice, LibreOffice, SQuirreL SQL) to read and write various versions of Microsoft Access databases.</description>
17+
<description>Actively maintained, pure Java JDBC driver for Microsoft Access databases (.mdb, .accdb) requiring no native libraries. A maintained fork of the unmaintained net.sf.ucanaccess project, built on current Jackcess and HSQLDB versions with Java 11/17/21 support. Used by Java applications and JDBC client programs (e.g. OpenOffice, LibreOffice, SQuirreL SQL) to read and write Microsoft Access databases.</description>
1818
<url>${githubBaseUrl}${project.artifactId}</url>
1919
<inceptionYear>2012</inceptionYear>
2020

0 commit comments

Comments
 (0)