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.

Sign up for GitHub

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

Jump to bottom

Remove heading numbering, fix internal refs, standardized RFC links #1107

Merged
merged 16 commits into from
Sep 11, 2024
Merged

Remove heading numbering, fix internal refs, standardized RFC links #1107

merged 16 commits into from
Sep 11, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Sep 6, 2024 •
edited
Loading

Heading numbers are now generated and some existing hard-coded anchors are not updated/wrong.

  • Remove unused heading anchors that based on Heading numbering (<a name="4.1" ...>)
  • Fix document internal refs to use #link that are not rely on heading numbering For example:
    • [text](#C.2.2) -> [text](#guideline-official-license-headers)
  • Standardized RFC links to use https://datatracker.ietf.org/doc/rfc... (this will fix 1/2 parts of What is a standard URL to reference IETF RFC? #1012 )
  • Add back SLSA to References, due to build: Clarify buildType spdx-3-model#875

Will fix #1012

@bact
Remove heading numbering and fix internal refs
adfe72b 
Heading numbers are now generated and some existing hard-coded anchors are not updated.

- Remove unused heading anchors that based on Heading numbering (`<a name="4. ...>`)
- Fix Annex internal refs to use `#link` that not rely on heading numbering
- Also fix typos in SPDX Lite
  - concludedLicense -> hasConcludedLicense
  - declaredLicense -> hasDeclaredLicense

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact added the publishing label Sep 6, 2024
@bact bact added this to the 3.0.1 milestone Sep 6, 2024
@bact bact requested review from zvr, goneall and kestewart September 6, 2024 11:28
@bact
3.0 - 3.0.1 in diagram image label
bde9795 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Copy link
Collaborator Author

bact commented Sep 6, 2024 •
edited
Loading

Note: the example validation failed because the redirection of RDFs on spdx.org are not up-to-date yet. See #1108

Update: the example validation needs to be updated by #1111 as well

zvr
zvr requested changes Sep 6, 2024
View reviewed changes
docs/annexes/spdx-license-expressions.md Outdated Show resolved Hide resolved
@bact @zvr
Update docs/annexes/spdx-license-expressions.md
bfcd93d 
Co-authored-by: Alexios Zavras (zvr) <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact requested a review from zvr September 6, 2024 14:38
@bact
Copy link
Collaborator Author

bact commented Sep 7, 2024 •
edited
Loading

Review suggestions merged.

@bact bact changed the title Remove heading numbering and fix internal refs + typos Remove heading numbering and fix internal refs Sep 7, 2024
@bact
Use https://datatracker.ietf.org/doc/rfc*
0b0fd31 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact changed the title Remove heading numbering and fix internal refs Remove heading numbering, fix internal refs, standardized RFC links Sep 9, 2024
@bact bact mentioned this pull request Sep 9, 2024
Closed
bact added 2 commits September 9, 2024 16:20
@bact
Add trailing / to RFC urls - same as canonical URLs
07e7906 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add trailing /
aec2aab 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
goneall
goneall approved these changes Sep 9, 2024
View reviewed changes
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

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

LGTM

kestewart
kestewart approved these changes Sep 10, 2024
View reviewed changes
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.

These are obsolete, not in use. Spec parser is using different method. Clean up.

Discussed on call, and no issue with merging raised.

@bact
Copy link
Collaborator Author

bact commented Sep 10, 2024 •
edited
Loading

Example validation failed - Joshua acknowledged that it is a know bug in shacl2code for 3.0.1

The working-in-progress PR is #1117, it will update the shacl2code to new version.
After PR 1117 got merged, update this PR again - the validation issue should be resolved.

bact added 3 commits September 10, 2024 17:50
@bact
Merge branch 'development/v3.0.1' into fix-annex-internal-refs
ad15917
@bact
Add back SLSA
604048f 
SLSA reintroduced because of spdx/spdx-3-model#875 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Update SLSA link
7e8db9e 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Copy link
Collaborator Author

bact commented Sep 10, 2024 •
edited
Loading

zvr
zvr approved these changes Sep 11, 2024
View reviewed changes
Copy link
Member

@zvr zvr left a comment

Choose a reason for hiding this comment

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

The failing CI has nothing to do with the content of this PR, so it can be merged

@bact
Copy link
Collaborator Author

bact commented Sep 11, 2024

I will merge this as we need the model files updated for the coming deadline. Review again and see no issues.

@bact bact merged commit af4d4f2 into spdx:development/v3.0.1 Sep 11, 2024
2 of 3 checks passed
@bact bact deleted the fix-annex-internal-refs branch September 11, 2024 23:19
@bact bact mentioned this pull request Sep 12, 2024
Closed
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kestewart kestewart kestewart approved these changes

@goneall goneall goneall approved these changes

@zvr zvr zvr approved these changes

Assignees
No one assigned
Labels
publishing
Projects
None yet
Milestone
3.0.1
Development

Successfully merging this pull request may close these issues.

What is a standard URL to reference IETF RFC?
4 participants
@bact @zvr @goneall @kestewart