Add ExApp development runbooks and a minimal reference ExApp - #962
Draft
oleksandr-nc wants to merge 4 commits into
Draft
Add ExApp development runbooks and a minimal reference ExApp#962oleksandr-nc wants to merge 4 commits into
oleksandr-nc wants to merge 4 commits into
Conversation
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
…ntenance runbooks Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds three runbooks under
docs/appapi/, written (like AGENTS.md) so that both humans and AI coding agents can follow them end to end:dev-environment.md: a from-scratch local dev environment on nextcloud-docker-dev with a HaRP daemon and a manual-install daemon, with a Verify gate after every stage.exapp-development.md: the ExApp contract for any language (endpoints, auth in both directions, packaging for HaRP) and the two development loops (manual-install fast loop, docker-install with a local-image registry mapping).exapp-ai-maintenance.md: fixing or extending an installed ExApp: get the source, change it, rebuild the image, redeploy throughapp_api:app:update --info-xmlwith aregistry ... to localmapping.examples/minimal_exapp/is a framework-free single-file ExApp implementing exactly the raw contract (heartbeat, enabled, init with OCS progress reporting, auth validation both directions, unix-socket mode for HaRP). It doubles as the guide's smoke test and as the porting reference for non-Python languages. Excluded from the release archive via.nextcloudignore.Everything stated was verified live against master + HaRP 0.4.3: all deploy loops, the injected environment, the heartbeat/init transcripts. As the acceptance test, a fresh agent executed the whole guide from a clean clone on a machine it had never seen: clone to deployed-and-answering ExApp in 19 minutes without human help, and its findings (plus an adversarial review pass) are folded into the text.
The release archive now includes
docs/(one removed line in.nextcloudignore, ~100 KB): the server bundle and store archives follow that file, so installed instances get AGENTS.md with all its runbooks next to it, version-matched and available offline; that matters most forexapp-ai-maintenance.md, which is written for production use.examples/stays repository-only and is linked absolutely from the shipped docs.