Page MenuHomeSoftware Heritage
Differential D4260

specs/blueprint: Align current status names and definitions
ClosedPublic
Actions

Authored by ardumont on Oct 14 2020, 3:34 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Maniphest Tasks
T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml
Commits
rDDEP3c1c6675952e: specs/blueprint: Align current status names and definitions
Summary

Status names were wrong.

Related to T2618

Test Plan

tox

Diff Detail

Repository
rDDEP Push deposit
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

ardumont created this revision.Oct 14 2020, 3:34 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptOct 14 2020, 3:34 PM
ardumont edited the summary of this revision. (Show Details)Oct 14 2020, 3:34 PM
swh-public-ci added a comment.Oct 14 2020, 3:37 PM

Build is green

Patch application report for D4260 (id=15048)

Could not rebase; Attempt merge onto 2f5300e60a...

Updating 2f5300e6..ff5f3787
Fast-forward
 docs/images/.gitignore               |   2 +-
 docs/images/deposit-create-chart.png | Bin 53678 -> 0 bytes
 docs/images/deposit-create-chart.svg |  38 +++++
 docs/images/deposit-delete-chart.png | Bin 56979 -> 0 bytes
 docs/images/deposit-delete-chart.svg |  45 +++++
 docs/images/deposit-delete-chart.uml |  29 ++--
 docs/images/deposit-update-chart.png | Bin 61584 -> 0 bytes
 docs/images/deposit-update-chart.svg |  51 ++++++
 docs/images/deposit-update-chart.uml |  20 ++-
 docs/specs/blueprint.rst             |  60 ++++---
 swh/deposit/api/deposit_update.py    |  24 +++
 swh/deposit/cli/admin.py             |  80 +++++----
 swh/deposit/tests/cli/conftest.py    |  12 ++
 swh/deposit/tests/cli/test_admin.py  | 317 +++++++++++++++++++++++++++++++++++
 swh/deposit/tests/cli/test_client.py |   8 +-
 15 files changed, 596 insertions(+), 90 deletions(-)
 delete mode 100644 docs/images/deposit-create-chart.png
 create mode 100644 docs/images/deposit-create-chart.svg
 delete mode 100644 docs/images/deposit-delete-chart.png
 create mode 100644 docs/images/deposit-delete-chart.svg
 delete mode 100644 docs/images/deposit-update-chart.png
 create mode 100644 docs/images/deposit-update-chart.svg
 create mode 100644 swh/deposit/tests/cli/conftest.py
 create mode 100644 swh/deposit/tests/cli/test_admin.py
Changes applied before test
commit ff5f37874f0b0ef0bf459632ede453f3367af046
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 15:34:30 2020 +0200

    specs/blueprint: Align current status names and definitions
    
    Related to T2618

commit 93f795c257941025a7d4fb0f07b4174dfe2ee6b7
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 15:06:19 2020 +0200

    deposit-create-chart: Drop png and integrate svg output

commit e40e295ff31e9109b0c137256487d37cb8920230
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:55:15 2020 +0200

    deposit-delete-chart: Clarify schema
    
    There is no need for the while loop in there.
    Also the status ready does not exist, it's name 'deposited' status.

commit 1abb2dc63e3a7a7e085b6773c09c13339d80a90c
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:54:30 2020 +0200

    deposit-update-chart: Clarify schema
    
    There is no need for the while loop in there

commit 34e710d07e88bb18e63a035e594a0bff7675b927
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 12:40:03 2020 +0200

    cli.admin: Add remaining coverage on `swh deposit reschedule` cli

commit 06f437255a222dbd42d788f6f143366ce1b41979
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 11:44:08 2020 +0200

    Add validation step after metadata ingestion of a metadata-only deposit
    
    Related to T2681

commit 51446a11df5cbd6608b282135ea5f2ff30791397
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Oct 13 14:59:50 2020 +0200

    deposit.cli.admin: Add types and coverage on module
    
    This will allow to be more confident when we will refactor the configuration
    part.

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/245/ for more details.

Harbormaster completed remote builds in B16275: Diff 15048.Oct 14 2020, 3:37 PM
ardumont mentioned this in D4248: Rewrite blueprint flowcharts using Plantuml instead of .png files..Oct 14 2020, 3:39 PM
ardumont updated this revision to Diff 15056.Oct 14 2020, 4:31 PM

Rebase

swh-public-ci added a comment.Oct 14 2020, 4:42 PM

Build is green

Patch application report for D4260 (id=15056)

Could not rebase; Attempt merge onto 4bb8a36d7a...

Updating 4bb8a36d..efceba23
Fast-forward
 docs/images/.gitignore               |   2 +-
 docs/images/deposit-create-chart.png | Bin 53678 -> 0 bytes
 docs/images/deposit-create-chart.svg |  38 ++++++++++++++++++++++
 docs/images/deposit-delete-chart.png | Bin 56979 -> 0 bytes
 docs/images/deposit-delete-chart.svg |  45 ++++++++++++++++++++++++++
 docs/images/deposit-delete-chart.uml |  29 +++++++----------
 docs/images/deposit-update-chart.png | Bin 61584 -> 0 bytes
 docs/images/deposit-update-chart.svg |  51 +++++++++++++++++++++++++++++
 docs/images/deposit-update-chart.uml |  20 ++++++------
 docs/specs/blueprint.rst             |  60 +++++++++++++++++++++++------------
 swh/deposit/api/deposit_update.py    |  24 ++++++++++++++
 11 files changed, 221 insertions(+), 48 deletions(-)
 delete mode 100644 docs/images/deposit-create-chart.png
 create mode 100644 docs/images/deposit-create-chart.svg
 delete mode 100644 docs/images/deposit-delete-chart.png
 create mode 100644 docs/images/deposit-delete-chart.svg
 delete mode 100644 docs/images/deposit-update-chart.png
 create mode 100644 docs/images/deposit-update-chart.svg
Changes applied before test
commit efceba23b6ae68c53fa2885bceadcc6cc11f6dcb
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 15:34:30 2020 +0200

    specs/blueprint: Align current status names and definitions
    
    Related to T2618

commit 6a9f76b85b3dc90ec78a14865245c8e97540e8b3
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 15:06:19 2020 +0200

    deposit-create-chart: Drop png and integrate svg output

commit 080ced795c5aab33ab77a67ab7b44aafc73d5107
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:55:15 2020 +0200

    deposit-delete-chart: Clarify schema
    
    There is no need for the while loop in there.
    Also the status ready does not exist, it's name 'deposited' status.

commit e39814c4af487fca889106b6cfe223b00f7672b7
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:54:30 2020 +0200

    deposit-update-chart: Clarify schema
    
    There is no need for the while loop in there

commit 92634764f00a0c561523f4fed8073cd9132a5c81
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 11:44:08 2020 +0200

    Add validation step after metadata ingestion of a metadata-only deposit
    
    Related to T2681

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/251/ for more details.

Harbormaster completed remote builds in B16283: Diff 15056.Oct 14 2020, 4:42 PM
vlorentz accepted this revision.Oct 15 2020, 10:30 AM
vlorentz mentioned this in D4258: deposit-delete-chart: Clarify sequence diagram.
This revision is now accepted and ready to land.Oct 15 2020, 10:30 AM
ardumont updated this revision to Diff 15071.Oct 15 2020, 10:48 AM

Rebase

swh-public-ci added a comment.Oct 15 2020, 10:57 AM

Build is green

Patch application report for D4260 (id=15071)

Could not rebase; Attempt merge onto 4bb8a36d7a...

Updating 4bb8a36d..b82364cc
Fast-forward
 docs/images/.gitignore               |   1 +
 docs/images/deposit-create-chart.png | Bin 53678 -> 0 bytes
 docs/images/deposit-delete-chart.png | Bin 56979 -> 0 bytes
 docs/images/deposit-delete-chart.uml |  29 +++++++----------
 docs/images/deposit-update-chart.png | Bin 61584 -> 0 bytes
 docs/images/deposit-update-chart.uml |  20 ++++++------
 docs/specs/blueprint.rst             |  60 +++++++++++++++++++++++------------
 7 files changed, 63 insertions(+), 47 deletions(-)
 delete mode 100644 docs/images/deposit-create-chart.png
 delete mode 100644 docs/images/deposit-delete-chart.png
 delete mode 100644 docs/images/deposit-update-chart.png
Changes applied before test
commit b82364cc41a6a6e21ba63e56314902cc2d6a14e1
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 15:34:30 2020 +0200

    specs/blueprint: Align current status names and definitions
    
    Related to T2618

commit feda207e124ae25100ec8a7342031efbaede02a5
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 15:06:19 2020 +0200

    deposit-create-chart: Drop out-of-sync png sequence diagram

commit 6e894be3749922b9004c1d11c6c19973bcb030d8
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:54:30 2020 +0200

    deposit-update-chart: Clarify sequence diagram
    
    There is no loop, either the status is partial, either it's not. Removing it
    clarifies the reading.
    
    This also drops the out-of-sync png diagram from the repository.

commit 2576c73a490956b8fd0c9573af504dbfb7ebdadf
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:55:15 2020 +0200

    deposit-delete-chart: Clarify schema
    
    There is no loop, either the status is partial, either it's not. Removing it
    clarifies the reading.
    
    This drops the out-of-sync png diagram from the repository. This also renames
    the inexistent `ready` status to the correct 'deposited' status.

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/256/ for more details.

Harbormaster completed remote builds in B16297: Diff 15071.Oct 15 2020, 10:57 AM
ardumont updated this revision to Diff 15078.Oct 15 2020, 11:42 AM

Rebase

swh-public-ci added a comment.Oct 15 2020, 11:53 AM

Build is green

Patch application report for D4260 (id=15078)

Could not rebase; Attempt merge onto 4bb8a36d7a...

Updating 4bb8a36d..3c1c6675
Fast-forward
 docs/images/.gitignore               |   1 +
 docs/images/deposit-create-chart.png | Bin 53678 -> 0 bytes
 docs/images/deposit-delete-chart.png | Bin 56979 -> 0 bytes
 docs/images/deposit-delete-chart.uml |  29 +++++++----------
 docs/images/deposit-update-chart.png | Bin 61584 -> 0 bytes
 docs/images/deposit-update-chart.uml |  20 ++++++------
 docs/specs/blueprint.rst             |  60 +++++++++++++++++++++++------------
 7 files changed, 63 insertions(+), 47 deletions(-)
 delete mode 100644 docs/images/deposit-create-chart.png
 delete mode 100644 docs/images/deposit-delete-chart.png
 delete mode 100644 docs/images/deposit-update-chart.png
Changes applied before test
commit 3c1c6675952e3343fb18168e26aa198487b7b102
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 15:34:30 2020 +0200

    specs/blueprint: Align current status names and definitions
    
    Related to T2618

commit d178775952b790a3f5c945635b8461a40a919cbb
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 15:06:19 2020 +0200

    deposit-create-chart: Drop out-of-sync png sequence diagram

commit 6097f14b7018f2f013a16aca4653698c7182b9ae
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:54:30 2020 +0200

    deposit-update-chart: Clarify sequence diagram
    
    There is no loop, either the status is partial, either it's not. Removing it
    clarifies the reading.
    
    This also drops the out-of-sync png diagram from the repository.

commit 4ee6ab25853c1eb3eb9f10763a4c2f48bfd30696
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:55:15 2020 +0200

    deposit-delete-chart: Clarify sequence diagram
    
    There is no loop, either the status is partial, either it's not. Removing it
    clarifies the reading.
    
    This drops the out-of-sync png diagram from the repository. This also renames
    the inexistent `ready` status to the correct 'deposited' status.

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/261/ for more details.

Harbormaster completed remote builds in B16304: Diff 15078.Oct 15 2020, 11:53 AM
Closed by commit rDDEP3c1c6675952e: specs/blueprint: Align current status names and definitions (authored by ardumont). · Explain WhyOct 15 2020, 2:25 PM
This revision was automatically updated to reflect the committed changes.
ardumont added a commit: rDDEP3c1c6675952e: specs/blueprint: Align current status names and definitions.

Revision Contents
Changeset List

PathSize
docs/
specs/
60 lines

Diff 15090

View Options

docs/specs/blueprint.rst

Loading...
About · Developer information · Legal