2024-05-10 18:41:18 +00:00
|
|
|
The [[git-remote-annex|/git-remote-annex]] command allows pushing a git
|
|
|
|
repository to a special remote, and later cloning from it.
|
|
|
|
|
2024-05-07 17:42:12 +00:00
|
|
|
This adds two new key types to git-annex, GITMANIFEST and a GITBUNDLE.
|
2024-04-06 09:28:29 +00:00
|
|
|
|
proof of concent for push to git bundles with MANIFEST
This is a shell script, so not final code, and it does not use git-annex
at all, but it shows how to push to git bundles, listed in a MANIFEST,
the same as the git-remote-annex program will eventually do.
While developing this, I realized that the design needed to be changed
slightly regarding where refs are stored. Since a push can delete a ref
from a remote, storing each newly pushed ref in a bundle won't work,
because deleting a ref would then entail deleting all old bundles and
re-uploading from scratch. So instead, only the refs in the last bundle
listed in the MANIFEST are the active refs. Any refs in prior bundles
are just old refs that were stored previously (a reflog as it were).
That means that, in a situation where two different people are pushing
to the same special remote from different repos, whoever pushes last
wins. Any refs pushed by the other person earlier will be ignored. This
may not be desirable, and git-annex might be able use the git-annex
branch to detect such situations and rescue the refs that got lost. Even
without such a recovery process though, the refs that the other person
thought they pushed will be preserved in their refs/namespaces/mine, so
a pull followed by a push will generally resolve the situation.
Note that the use of refs/namespaces/mine in the bundle is not really
desirable, and it might be worth making a local clone of the repo in
order to set up the refs that will be put in the bundle. Which seems to
be the only way to avoid needing that. But it does need to maintain
the refs/namespaces/mine/ in the git repo in order to remember what refs
have been pushed to the remote before, in order to include them in the
next bundle pushed. A name that includes the remote uuid will be needed
in the final implementation.
Anyway, this shell script seems to fully work, including incremental
pushing, force pushing, and pushes that delete refs.
Sponsored-by: Brett Eisenberg on Patreon
2024-04-25 20:38:34 +00:00
|
|
|
GITMANIFEST--$UUID is the manifest for a git repository stored in the
|
2024-04-06 12:30:51 +00:00
|
|
|
git-annex repository with that UUID.
|
2024-04-06 09:28:29 +00:00
|
|
|
|
2024-05-06 20:25:55 +00:00
|
|
|
GITBUNDLE--$UUID-sha256 is a git bundle.
|
2024-04-06 09:28:29 +00:00
|
|
|
|
|
|
|
# format of the manifest file
|
|
|
|
|
2024-05-06 20:25:55 +00:00
|
|
|
An ordered list of bundle keys, one per line.
|
|
|
|
|
|
|
|
(Lines end with unix `"\n"`, not `"\r\n"`.)
|
2024-04-06 09:28:29 +00:00
|
|
|
|
2024-04-06 12:30:51 +00:00
|
|
|
# multiple GITMANIFEST files
|
|
|
|
|
|
|
|
Usually there will only be one per special remote, but it's possible for
|
|
|
|
multiple special remotes to point to the same object storage, and if so
|
|
|
|
multiple GITMANIFEST objects can be stored.
|
|
|
|
|
2024-05-10 18:41:18 +00:00
|
|
|
This is why the UUID of the special remote is included in the GITMANIFEST
|
|
|
|
key, and in the annex:: uri.
|
|
|
|
|
|
|
|
# manually cloning from these files
|
|
|
|
|
|
|
|
If you are unable to use git-annex and need to clone a git repository
|
|
|
|
stored in such a special remote, this procedure will work:
|
|
|
|
|
|
|
|
* Find and download the GITMANIFEST
|
|
|
|
* Download each listed GITBUNDLE
|
|
|
|
* `git fetch` from each new bundle in order.
|
|
|
|
(Note that later bundles can update refs from the versions in previous
|
|
|
|
bundles.)
|
|
|
|
|
|
|
|
When the special remote is encryptee, the GITMANIFEST and GITBUNDLE will
|
|
|
|
also be encrypted. To decrypt those manually, see this
|
|
|
|
[[fairly simple shell script using standard tools|tips/Decrypting_files_in_special_remotes_without_git-annex]].
|