Page MenuHomeSoftware Heritage
Differential D4257

deposit-update-chart: Clarify sequence diagram
ClosedPublic
Actions

Authored by ardumont on Oct 14 2020, 2:56 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Maniphest Tasks
T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml
T2628: Recycle ceph-osd2 as objstorage/storage backend for staging
Commits
rDDEP6097f14b7018: deposit-update-chart: Clarify sequence diagram
Summary

This also drops the deprecated committed png file.

Related to T2618

Test Plan

tox

Diff Detail

Event Timeline

ardumont created this revision.Oct 14 2020, 2:56 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptOct 14 2020, 2:56 PM
ardumont updated this revision to Diff 15044.Oct 14 2020, 3:04 PM

Drop deprecated png file and integrate the svg file instead

ardumont updated this revision to Diff 15045.Oct 14 2020, 3:06 PM

Actually dropping deprecated png file and integrate the svg file instead

swh-public-ci added a comment.Oct 14 2020, 3:06 PM

Build is green

Patch application report for D4257 (id=15042)

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

Updating 2f5300e6..2f519ed9
Fast-forward
 docs/images/deposit-update-chart.uml |  20 ++-
 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 +-
 6 files changed, 410 insertions(+), 51 deletions(-)
 create mode 100644 swh/deposit/tests/cli/conftest.py
 create mode 100644 swh/deposit/tests/cli/test_admin.py
Changes applied before test
commit 2f519ed955ed5e43688c43c5de56d48a0bc83101
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/240/ for more details.

Harbormaster completed remote builds in B16269: Diff 15042.Oct 14 2020, 3:06 PM
swh-public-ci added a comment.Oct 14 2020, 3:09 PM

Build is green

Patch application report for D4257 (id=15044)

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

Updating 2f5300e6..2f519ed9
Fast-forward
 docs/images/deposit-update-chart.uml |  20 ++-
 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 +-
 6 files changed, 410 insertions(+), 51 deletions(-)
 create mode 100644 swh/deposit/tests/cli/conftest.py
 create mode 100644 swh/deposit/tests/cli/test_admin.py
Changes applied before test
commit 2f519ed955ed5e43688c43c5de56d48a0bc83101
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/241/ for more details.

Harbormaster completed remote builds in B16271: Diff 15044.Oct 14 2020, 3:09 PM
swh-public-ci added a comment.Oct 14 2020, 3:12 PM

Build is green

Patch application report for D4257 (id=15045)

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

Updating 2f5300e6..1abb2dc6
Fast-forward
 docs/images/deposit-update-chart.png | Bin 61584 -> 0 bytes
 docs/images/deposit-update-chart.svg |  51 ++++++
 docs/images/deposit-update-chart.uml |  20 ++-
 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 +-
 8 files changed, 461 insertions(+), 51 deletions(-)
 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 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/242/ for more details.

Harbormaster completed remote builds in B16272: Diff 15045.Oct 14 2020, 3:12 PM
ardumont edited the summary of this revision. (Show Details)Oct 14 2020, 3:13 PM
ardumont edited the summary of this revision. (Show Details)
ardumont edited the summary of this revision. (Show Details)Oct 14 2020, 3:26 PM
ardumont added a task: T2628: Recycle ceph-osd2 as objstorage/storage backend for staging.
ardumont edited the summary of this revision. (Show Details)
ardumont added a task: T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml.
ardumont mentioned this in D4248: Rewrite blueprint flowcharts using Plantuml instead of .png files..Oct 14 2020, 3:29 PM
ardumont updated this revision to Diff 15053.Oct 14 2020, 4:30 PM
ardumont edited the summary of this revision. (Show Details)

Rebase

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

Build is green

Patch application report for D4257 (id=15053)

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

Updating 4bb8a36d..e39814c4
Fast-forward
 docs/images/deposit-update-chart.png | Bin 61584 -> 0 bytes
 docs/images/deposit-update-chart.svg |  51 +++++++++++++++++++++++++++++++++++
 docs/images/deposit-update-chart.uml |  20 +++++++-------
 swh/deposit/api/deposit_update.py    |  24 +++++++++++++++++
 4 files changed, 86 insertions(+), 9 deletions(-)
 delete mode 100644 docs/images/deposit-update-chart.png
 create mode 100644 docs/images/deposit-update-chart.svg
Changes applied before test
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/248/ for more details.

Harbormaster completed remote builds in B16280: Diff 15053.Oct 14 2020, 4:34 PM
vlorentz requested changes to this revision.Oct 15 2020, 10:23 AM
vlorentz added a subscriber: vlorentz.

You don't need to include the SVG file

This revision now requires changes to proceed.Oct 15 2020, 10:23 AM
vlorentz added a comment.Oct 15 2020, 10:26 AM

also, "schéma" doesn't translate to "schema" in English (instead: diagram, schematic, ...)

And the commit message should mention that you changed the flowchart (and what/why), it's not just a clarification

vlorentz mentioned this in D4258: deposit-delete-chart: Clarify sequence diagram.Oct 15 2020, 10:26 AM
ardumont updated this revision to Diff 15069.Oct 15 2020, 10:46 AM
  • Drop svg
  • Rework commit message
swh-public-ci added a comment.Oct 15 2020, 10:51 AM

Build is green

Patch application report for D4257 (id=15069)

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

Updating 4bb8a36d..6e894be3
Fast-forward
 docs/images/.gitignore               |   1 +
 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 +++++++++++---------
 5 files changed, 24 insertions(+), 26 deletions(-)
 delete mode 100644 docs/images/deposit-delete-chart.png
 delete mode 100644 docs/images/deposit-update-chart.png
Changes applied before test
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/254/ for more details.

Harbormaster completed remote builds in B16295: Diff 15069.Oct 15 2020, 10:51 AM
vlorentz accepted this revision.Oct 15 2020, 11:33 AM
This revision is now accepted and ready to land.Oct 15 2020, 11:33 AM
ardumont updated this revision to Diff 15076.Oct 15 2020, 11:42 AM

Rebase

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

Build is green

Patch application report for D4257 (id=15076)

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

Updating 4bb8a36d..6097f14b
Fast-forward
 docs/images/.gitignore               |   1 +
 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 +++++++++++---------
 5 files changed, 24 insertions(+), 26 deletions(-)
 delete mode 100644 docs/images/deposit-delete-chart.png
 delete mode 100644 docs/images/deposit-update-chart.png
Changes applied before test
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/259/ for more details.

Harbormaster completed remote builds in B16302: Diff 15076.Oct 15 2020, 11:47 AM
ardumont retitled this revision from deposit-update-chart: Clarify schema to deposit-update-chart: Clarify sequence diagram.Oct 15 2020, 1:25 PM
ardumont edited the summary of this revision. (Show Details)
Closed by commit rDDEP6097f14b7018: deposit-update-chart: Clarify sequence diagram (authored by ardumont). · Explain WhyOct 15 2020, 2:25 PM
This revision was automatically updated to reflect the committed changes.
ardumont added a commit: rDDEP6097f14b7018: deposit-update-chart: Clarify sequence diagram.

Revision Contents
Changeset List

Diff 15076

View Options

docs/images/.gitignore

Loading...
View Options

docs/images/deposit-update-chart.png

Loading...
View Options

docs/images/deposit-update-chart.uml

Loading...
About · Developer information · Legal