Skip to content

docs: settle the config format on F2, add GitHub - #9

Merged
tobixen merged 2 commits into
mainfrom
config-format-f2
Oct 15, 2026
Merged

tobixen merged 2 commits into
mainfrom
config-format-f2

Conversation

@tobixen

@tobixen tobixen commented Oct 14, 2026

Copy link
Copy Markdown
Member

Replaces #6, which was closed by accident (its base branch, roadmap-1.1, went away when #5 merged). The discussion is still there.

PR 6 put three config formats up for comparison. This PR settles on the second one, F2, which Claude recommended and Sashank and I prefer. F1 and F3 are now summarised in a sentence each. The points agreed in the PR 6 thread are written into the spec:

  • environment variables override the file
  • _command takes an argument list and runs without a shell
  • a _command file is refused if others can write to it

Where the parser lives (option B or C) is still open.

🤖 Generated with Claude Code

CONFIGURATION_PROPOSAL.md now specifies F2, a `kind` key with the keys
Backend.connect() takes, which keeps caldav's file and
calendaring-jmap's key names in one file. Prefixed keys (F1) and a new
TOML file (F3) are reduced to a few words each. From the review of the
earlier draft: env vars win over the file, a `_command` is an argument
list run without a shell and refused from a file others can write.
Rechecking caldav's parser found an inherits leak across backends and an
unsafe yaml.Loader, and backward compatibility is now wanted rather than
required. GitHub goes on the roadmap as the first unfunded tracker after
Gitea.

Prompt: Start working on roadmap 1.4 - configuration file.  Suggest some few different alternatives for how to do it.  The configuration file needs to be compatible with the current caldav configuration file, but it should also support jmap, icalendar files, and arbitrary other backends (gitea being one of the first - and even if it's not funded, I think we should prioritize github since it's what we're using internally.  Please look through the roadmap and add GitHub).  Also look into the jmap-client, it should be cloned locally from the pycalendar org on github ... "needs to" is perhaps a bit strong wording - it would be nice to be backward compatible, if nothing else
Followup-Prompt: #6 was closed by accident.  Anyway, it was a draft with three different suggestions for the config file.  Resurrect the content, choose the 2nd alternative (recommended by Claude and preferred by me and Sashank), summarize the alternatives in some few words, and make a new pull request, maybe with a clean commit from master.

Assisted-By: Claude Opus 5.5 via Claude Code
Reviewed-by: Tobias Brox <tobias@redpill-linpro.com>
@tobixen tobixen added documentation Improvements or additions to documentation skip-changelog No changelog fragment needed labels Oct 14, 2026
The PR 6 points were already in the spec, but "environment variables
win, as in both libraries" was not true: caldav lets any CALDAV_*
connection variable replace the whole file.  Specify the rule per
kind: an env URL skips the file, other variables override the one
section read key by key, as calendaring-jmap does.  Also list
caldav's real search path and note that calendaring-sync has no
configuration.

Prompt: (...).  Please ensure that those details are in the spec [from the last comments in #6].  Please check how the caldav implementation works today.

Assisted-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Reviewed-by: Tobias Brox <tobias@redpill-linpro.com>
@tobixen
tobixen merged commit bcd5970 into main Oct 15, 2026
7 checks passed
@tobixen
tobixen deleted the config-format-f2 branch October 16, 2026 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skip-changelog No changelog fragment needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant