chore: Improve script documentation and initial comments
This commit is contained in:
parent
a1de7ad954
commit
80fa4c8eda
1 changed files with 5 additions and 6 deletions
|
|
@ -1,12 +1,11 @@
|
|||
#!/bin/bash
|
||||
# genome-raw-commit <genome>
|
||||
#
|
||||
# Commits raw files synchronized by Syncthing into the vault and pushes them to origin/<base>.
|
||||
# - Committer = n8n-bot (robotic identity responsible for pushing)
|
||||
# - Author = deduced from the Syncthing device ID (modifiedBy field), resolved via .authors.json.
|
||||
# Falls back to default values if unknown.
|
||||
# - One commit per author/device to ensure clear attribution.
|
||||
# - No-op if no changes are present. Excludes infrastructure files and private folders.
|
||||
# Commit the raw files that Syncthing has placed in the vault and push them to origin/<base>.
|
||||
# - Committer = n8n-bot (sole pusher); Author = the person who wrote it (Syncthing modifiedBy -> .authors.json)
|
||||
# - One commit per author (single-device => one commit). No-op if there is nothing.
|
||||
# - JSON output built with jq (safe escaping), with a `files` array:
|
||||
# for each raw -> file, author, local_path, local_url (file://), remote_url (Forgejo web).
|
||||
|
||||
set -euo pipefail
|
||||
genome="${1:?usage: genome-raw-commit <genome>}"
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue