test: prepare for v1.0-release

tobixen · tobixen · commit 3394fb9ef6e8 · 2026-03-15T23:35:35.000+01:00
diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml
@@ -0,0 +1,41 @@
+name: Link check
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+  schedule:
+   - cron: "03 22 * * *"
+
+jobs:
+  linkcheck:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Restore lychee cache
+      uses: actions/cache@v4
+      with:
+        path: .lycheecache
+        key: cache-lychee-${{ github.sha }}
+        restore-keys: cache-lychee-
+    - name: Check links with Lychee
+      id: lychee
+      uses: lycheeverse/lychee-action@v2
+      with:
+        fail: false
+        args: >-
+          --root-dir "$(pwd)"
+          --timeout 20
+          --max-retries 3
+          --cache
+          --max-cache-age 14d
+          .
+    - name: Create Issue From File
+      if: steps.lychee.outputs.exit_code != 0
+      uses: peter-evans/create-issue-from-file@v5
+      with:
+        title: Link Checker Report
+        content-filepath: ./lychee/out.md
+        labels: report, automated issue
diff --git a/.lycheeignore b/.lycheeignore
@@ -0,0 +1,2 @@
+## fsf.org redirects to www.fsf.org, but I don't want to change the LICENSE file due to that.  Also, fsf.org fails evey now and then.  Ignoring it ...
+https://fsf.org
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -30,6 +30,13 @@ repos:
 
  - repo: local
    hooks:
+    # Prevent direct pushes to main branch (bypass with --no-verify for releases)
+    - id: no-push-to-main
+      name: Prevent direct push to main branch
+      entry: bash -c 'branch=$(git rev-parse --abbrev-ref HEAD); if [ "$branch" = "main" ] || [ "$branch" = "master" ]; then echo "Direct pushes to $branch are not allowed. Use --no-verify to bypass."; exit 1; fi'
+      language: system
+      pass_filenames: false
+      stages: [pre-push]
     # Run ruff check without fixes on push (to catch any issues)
     - id: ruff-check-push
       name: Ruff check (no fixes)
@@ -47,6 +54,12 @@ repos:
       always_run: true
       stages: [pre-push]
 
+ - repo: https://github.com/compilerla/conventional-pre-commit
+   rev: v3.4.0
+   hooks:
+    - id: conventional-pre-commit
+      stages: [commit-msg]
+
  - repo: https://github.com/fpgmaas/deptry.git
    rev: "0.24.0"
    hooks:
@@ -56,5 +69,5 @@ repos:
    rev: lychee-v0.22.0
    hooks:
     - id: lychee
-      args: ["--no-progress", "--timeout", "10", "."]
-      stages: [manual]  # Run with: pre-commit run lychee --hook-stage manual
+      args: ["--no-progress", "--timeout", "10", "--cache", "--max-cache-age", "1d", "."]
+      stages: [pre-push]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,11 +6,24 @@ This file should adhere to [Keep a Changelog](https://keepachangelog.com/en/1.1.
 
 This project should adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), though some earlier releases may be incompatible with the SemVer standard.
 
+## [1.0.0] - 2026-03-15
+
+### Changed
+- Minimum required `caldav` library version bumped to 3.0.2.
+- Text report now labels extra check information with "Extra check information:" header (rationale: it was a bit confusing with two "descriptions" on one feature).
+
+### Documentation, tests, CI etc
+- Added `CONTRIBUTING.md` with contribution guidelines
+- Conventional commit message enforcement via `conventional-pre-commit` pre-commit hook
+- Link checker CI workflow
+- Development status classifier updated to Production/Stable
+
+
 ## [0.2.2] - 2026-03-11
 
 Lots of changes have been done since v0.1.0.  I'm not sure the changelog is complete, I didn't get time to do a proper QA on it.  CalDAV version 3.0 is required.
 
-Version 1.0 will be released in some few days, this may be considered as a pre-release.
+This was a pre-release; version 1.0.0 followed shortly after.
 
 (Version 0.2.0/9.2.1 was never published due to problems with the auto-publish workflow)
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+# Contributing to caldav-server-tester
+
+Contributions are mostly welcome (but do inform about it if you've used AI or other tools).  If the length of this text scares you, then I'd rather want you to skip reading and just produce a pull-request in GitHub.  If you find it too difficult to write test code, etc, then you may skip it and hope the maintainer will fix it.
+
+## What to include
+
+Every submission should ideally include:
+
+- **Test code** covering the new behaviour or bug fix
+- **Documentation** updates where relevant (README, USAGE.md)
+- **A changelog entry** in `CHANGELOG.md` under `[Unreleased]`
+
+## Commit messages
+
+Please follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and write messages in the imperative mood:
+
+- `fix: correct time-range search handling for recurring events`
+- `feat: add free-busy query check`
+- `docs: update USAGE.md with --diff flag example`
+
+Rather than:
+
+- `This commit fixes the time-range search`
+- `Added free-busy query check`
+
+Note: older commits in this repository predate this convention and do not follow it.
+
+## Reporting bugs
+
+Open an issue on GitHub.  Include the server name/version and the output of `caldav-server-tester --version`.
diff --git a/README.md b/README.md
@@ -29,9 +29,11 @@ For full usage information, including all CLI options and output formats, see
 ## Installation
 
 ```
-pip install caldav-server-tester
+make install
 ```
 
+(This auto-detects `uv`, `pipx`, or `pip` and does the right thing.)
+
 ## Quick example
 
 ```
diff --git a/docs/TODO.md b/docs/TODO.md
@@ -4,5 +4,5 @@
 * [x] New TODO-items have been added to USAGE.md.  They should be fixed and removed from this file prior to the v1.0-release
 * [x] Search for other TODO-notes in the project
 * [x] `src/caldav_server_tester/caldav_server_tester_old.py` is 1028 lines, not imported anywhere - consider deleting it
-* [] It's needed to test it towards a server that does not allow calendars to be created
-* [] The text-based description should be prettified
+* [x] It's needed to test it towards a server that does not allow calendars to be created
+* [x] The text-based description should be prettified
diff --git a/pyproject.toml b/pyproject.toml
@@ -9,7 +9,7 @@ authors = [
 readme = "README.md"
 requires-python = ">=3.10"
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Intended Audience :: System Administrators",
@@ -26,7 +26,7 @@ classifiers = [
 ]
 keywords = ["caldav", "calendar", "testing", "compatibility", "server"]
 dependencies = [
-    "caldav>=3.0.1",
+    "caldav>=3.0.2",
     "click",
     "pyyaml",
 ]
diff --git a/src/caldav_server_tester/checker.py b/src/caldav_server_tester/checker.py
@@ -226,6 +226,7 @@ def report(self, verbose=False, show_diff=False, return_what=str):
                 lines.append(f"## {feature}")
                 lines.append(f"Feature support level found: {support}")
                 if extras:
+                    lines.append("Extra check information:")
                     lines.append(extra_str)
                 if description:
                     lines.append(f"Description of the feature: {description}")

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+## fsf.org redirects to www.fsf.org, but I don't want to change the LICENSE file due to that. Also, fsf.org fails evey now and then. Ignoring it ...`
	`2`	`+https://fsf.org`