diff --git a/talks-public/2018-02-04-deposit-vault-walkthrough/deposit-vault-walkthrough.org b/talks-public/2018-02-04-deposit-vault-walkthrough/deposit-vault-walkthrough.org --- a/talks-public/2018-02-04-deposit-vault-walkthrough/deposit-vault-walkthrough.org +++ b/talks-public/2018-02-04-deposit-vault-walkthrough/deposit-vault-walkthrough.org @@ -23,25 +23,25 @@ * Source code deposit: the new SWH push feature -** Source code deposit: the new SWH push feature +** Source code deposit: the new SWH push feature :PROPERTIES: :CUSTOM_ID: walkthrough :END: -**** +**** First version of our software deposit prototype \\ *\url{https://deposit.softwareheritage.org/}* **** Features - pushing *deposits* to the Software Heritage archive - - software source code + metadata + - software source code + metadata - full *transparency* of the loading and downloading processes - download the deposit by cooking the bundle in the *vault* -**** SWORD-compliant +**** SWORD-compliant - *SWORD v2* protocol for single and multipart deposits - - deposit /MUST/, /SHOULD/ and /MAY/ contain certain metadata attributes + - deposit /MUST/, /SHOULD/ and /MAY/ contain certain metadata attributes * Deposit walkthrough -** Deposit walkthrough +** Deposit walkthrough *** Prepare source code for deposit #+BEAMER: \tiny #+BEGIN_SRC @@ -57,7 +57,7 @@ - *the author/s*- one or more authors /MUST/ be provided -*** +*** #+BEAMER: \tiny #+BEGIN_SRC @@ -66,7 +66,7 @@ Je suis GPL ext-id forge.softwareheritage.org/source/jesuisgpl/ - Yes, this is another implementation of + Yes, this is another implementation of "Hello, world!” when you run it. GPL @@ -82,17 +82,17 @@ -** Deposit walkthrough +** Deposit walkthrough *** Pushing a single deposit with metadata #+BEAMER: \tiny #+BEGIN_SRC -$ swh-deposit --username 'name' --password 'pass' je-suis-gpl.tgz +$ swh-deposit --username 'name' --password 'pass' --archive je-suis-gpl.tgz #+END_SRC #+BEAMER: \pause *** Response -#+BEAMER: \tiny +#+BEAMER: \tiny #+BEGIN_SRC 11 @@ -110,7 +110,7 @@ #+END_SRC -** Deposit walkthrough +** Deposit walkthrough *** multipart deposit #+BEAMER: \footnotesize A multipart deposit with *partial* status can be: @@ -118,32 +118,35 @@ - updated with new content or metadata #+BEAMER: \pause - + *** Update by replacing archive and metadata -#+BEAMER: \tiny +#+BEAMER: \tiny #+BEGIN_SRC $ swh-deposit --username 'name' --password 'secret' \ - --deposit-id 11 updated-je-suis-gpl.tar.gz + --deposit-id 11 --replace \ + --archive updated-je-suis-gpl.tar.gz #+END_SRC #+BEAMER: \pause *** Complete multipart deposit -#+BEAMER: \tiny +#+BEAMER: \tiny #+BEGIN_SRC $ swh-deposit --username 'name' --password 'secret' --partial \ - foo.tar.gz + --archive foo.tar.gz $ swh-deposit --username 'name' --password 'secret' --partial \ - --deposit-id 42 add-foo.tar.gz + --deposit-id 42 \ + --archive add-foo.tar.gz $ swh-deposit --username 'name' --password 'secret' \ - --deposit-id 42 last-foo.tar.gz + --deposit-id 42 \ + --archive last-foo.tar.gz #+END_SRC -** Deposit walkthrough +** Deposit walkthrough *** What's your status? #+BEAMER: \footnotesize @@ -179,26 +182,23 @@ *** Checking the deposit's state #+BEAMER: \tiny #+BEGIN_SRC -$ swh-deposit --login 'name' --pass 'secret' --deposit-id '11' \ +$ swh-deposit --username 'name' --pass 'secret' --deposit-id '11' \ --collection 'col' --status #+END_SRC #+BEAMER: \pause -*** +*** #+BEAMER: \tiny #+BEGIN_SRC -HTTP/1.0 200 OK -Date: Thu, 04 Jan 2018 15:20:12 GMT... - - 11 - done - The deposit has been successfully loaded into - the Software Heritage archive - swh:1:rev:sha1:608757ea... - +{ + 'deposit_id': 11, + 'deposit_status': 'done', + 'deposit_status_detail': The deposit has been successfully loaded into the Software Heritage archive', + 'deposit_swh_id': 'swh:1:rev:608757ea9bd8494d729732cc9a414948c160bd3c' +} #+END_SRC -** +** *** Deposit completed and loaded The deposit was succesfuly pushed and integrated into the archive.\\ You can browse it using the deposit's /swh-id/: @@ -207,7 +207,7 @@ *** Download Now we want to download the content with the -#+BEAMER: \huge +#+BEAMER: \huge *Vault* @@ -215,7 +215,7 @@ ** Vault walkthrough *** Software identifier to request download #+BEAMER: \footnotesize -The swh-id *swh:1:rev:608757ea9bd8494d729732cc9a414948c160bd3c* +The swh-id *swh:1:rev:608757ea9bd8494d729732cc9a414948c160bd3c* is composed of: - the context *swh:1:rev* @@ -226,7 +226,7 @@ #+BEAMER: \tiny #+BEGIN_SRC sh $ curl -X POST /api/1/vault/revision/608757ea.../gitfast -#+END_SRC +#+END_SRC *** Email notification #+BEAMER: \footnotesize @@ -237,21 +237,21 @@ #+BEAMER: \tiny #+BEGIN_SRC sh $ curl /api/1/vault/revision/608757ea.../gitfast -#+END_SRC -# can we cook objects that aren't revisions? +#+END_SRC +# can we cook objects that aren't revisions? *** Response #+BEAMER: \tiny #+BEGIN_SRC json { 'fetch_url': '/api/1/vault/revision/608757ea.../gitfast/raw/', - 'progress_message': None, - 'status': 'pending', - 'id': 4, - 'obj_id': '608757ea9bd8494d729732cc9a414948c160bd3c', + 'progress_message': None, + 'status': 'pending', + 'id': 4, + 'obj_id': '608757ea9bd8494d729732cc9a414948c160bd3c', 'obj_type': 'revision_gitfast' } -#+END_SRC +#+END_SRC *** What's your status? #+BEAMER: \small @@ -281,20 +281,20 @@ #+BEAMER: \tiny #+BEGIN_SRC sh $ curl /api/1/vault/revision/608757ea.../gitfast -#+END_SRC +#+END_SRC *** Response #+BEAMER: \tiny #+BEGIN_SRC json { 'fetch_url': '/api/1/vault/revision/608757ea.../gitfast/raw/', - 'progress_message': None, - 'status': 'done', - 'id': 4, - 'obj_id': '608757ea9bd8494d729732cc9a414948c160bd3c', + 'progress_message': None, + 'status': 'done', + 'id': 4, + 'obj_id': '608757ea9bd8494d729732cc9a414948c160bd3c', 'obj_type': 'revision_gitfast' } -#+END_SRC +#+END_SRC *** Download available when status is marked /done/ #+BEAMER: \tiny @@ -305,4 +305,4 @@ $ git init $ zcat path/to/revision.gitfast.gz | git fast-import $ git checkout HEAD -#+END_SRC +#+END_SRC