Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional migration documentation for relationship types #1019

Merged
merged 8 commits into from
Aug 8, 2024

Conversation

goneall
Copy link
Member

@goneall goneall commented Aug 4, 2024

Rather than removing support for the SPDX 2.X relationships, it looks like we can just reverse the direction and use one of the SPDX 3.X relationship types.

I also found one or two relationship types that was not documented.

Rather than removing support for the SPDX 2.X relationships, it looks like we can just reverse the direction and use one of the SPDX 3.X relationship types.

Signed-off-by: Gary O'Neall <[email protected]>
@goneall goneall added this to the 3.0.1 milestone Aug 4, 2024
@goneall goneall requested a review from kestewart August 4, 2024 21:30
@bact
Copy link
Collaborator

bact commented Aug 5, 2024

It looks the direction column is not complete as well (not your PR but the existing one). I will just copied my comments from #1017 (comment)

Questions

  1. Does this table complete?
    • A sentence before the table said:

      Relationship migration is being worked out in the relationships spreadsheet. Once completed, the following table will reflect the translation for relationship types from SPDX 2.3 to SPDX 3.0:

  2. What does "lifecycle scope" in the last column mean?
    • Other values in this column are types in LifecycleScopeType (for example, "build", "build, runtime", "test") or a string stating "various LifecycleScopeType".
    • Should this "lifecycle scope" string be replaced by "various LifecycleScopeType"?
  3. The 3rd column ("Swap to and from?") probably not complete?
    • For example, 2.3 DATA_FILE_OF and 3.0 hasDataFile they are swapped in direction. But there's no "Y" marked in their column.
    • A (is a) DATA_FILE_OF B
    • B hasDataFile A

@bact
Copy link
Collaborator

bact commented Aug 5, 2024

@goneall do you mind to fix typo hasPrequisite / hasPrerequisite typo at line 242 please? So we can close #1017 and use this PR instead.

@bact bact mentioned this pull request Aug 5, 2024
69 tasks
@goneall
Copy link
Member Author

goneall commented Aug 5, 2024

@goneall do you mind to fix typo hasPrequisite / hasPrerequisite typo at line 242 please? So we can close #1017 and use this PR instead.

Done

@goneall
Copy link
Member Author

goneall commented Aug 5, 2024

It looks the direction column is not complete as well (not your PR but the existing one). I will just copied my comments from #1017 (comment)

Questions

  1. Does this table complete?

    • A sentence before the table said:

      Relationship migration is being worked out in the relationships spreadsheet. Once completed, the following table will reflect the translation for relationship types from SPDX 2.3 to SPDX 3.0:

  2. What does "lifecycle scope" in the last column mean?

    • Other values in this column are types in LifecycleScopeType (for example, "build", "build, runtime", "test") or a string stating "various LifecycleScopeType".
    • Should this "lifecycle scope" string be replaced by "various LifecycleScopeType"?
  3. The 3rd column ("Swap to and from?") probably not complete?

    • For example, 2.3 DATA_FILE_OF and 3.0 hasDataFile they are swapped in direction. But there's no "Y" marked in their column.
    • A (is a) DATA_FILE_OF B
    • B hasDataFile A

We should fix these as well - I won't have time to go through another pass before my trip - perhaps we can open a separate PR for the remaining questions.

Ping @kestewart

@bact
Copy link
Collaborator

bact commented Aug 5, 2024

We should fix these as well - I won't have time to go through another pass before my trip - perhaps we can open a separate PR for the remaining questions.

Agree. Let's merge this first and manage other stuff in another PR.

@bact
Copy link
Collaborator

bact commented Aug 5, 2024

I have open PR #1022, as a patch to @goneall's branch, to add all missing directions, fix typos in descendantOf and hasVariant names, and address all the three questions above.

bact added 3 commits August 5, 2024 18:29
Signed-off-by: Arthit Suriyawongkul <[email protected]>

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@kestewart kestewart requested a review from rnjudge August 6, 2024 16:33
Co-authored-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Kate Stewart <[email protected]>
Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the cleanup and making things more consistent.

@zvr zvr merged commit 529433c into development/v3.0.1 Aug 8, 2024
4 checks passed
@zvr zvr deleted the goneall-relationship-migration branch August 8, 2024 16:26
@bact
Copy link
Collaborator

bact commented Sep 5, 2024

To future readers, this doc is no longer in this repo and is now available at https://github.com/spdx/using/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants