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

First draft of classes and properties as base for discussion WIP! #897

Merged
merged 26 commits into from
Oct 21, 2024

Conversation

mkurzman
Copy link

as preparation for the peer review and discussion in the Operation Profile round.
Open points:

  • use of relations instead of properties?
  • abstraction of properties to classes? (e.g. Delivery-class merely added as empty envelope)
  • redundancy of properties that are already defined in other profiles?
  • correct definition of types etc.

umm0 and others added 24 commits August 16, 2024 16:36
Signed-off-by: Ummo Schwarting <69399030+umm0@users.noreply.github.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Co-authored-by: Gary O'Neall <gary@sourceauditor.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
- Fix typos in model descriptions
- Make sure that the property names have correct casing (starts with a lowercase letter) in model descriptions
- Add "The" to entry description of SoftwarePurpose (some already have, some don't; also make "The" casing consistent with entry description in other vocabs)

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Fix typos, casing, and make SoftwarePurpose entry description consistent
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
[CHANGELOG] Add changes in buildType and SpdxOrganization
- "Asbtract" -> "Abstract"
- Also fix inconsistent use of emphasis markup (`_,,,_` -> `*...*`)

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
…ionship

Fix typo: Asbtract -> Abstract.

Merge with 1 approval because it is minor and time constraint for PDF production, please kindly revert if there's an issue.
Bumps [actions/checkout](https://github.com/actions/checkout) from 4.1.7 to 4.2.0.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@692973e...d632683)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Fix typos: an -> a; descendents -> descendants
Bumps [actions/checkout](https://github.com/actions/checkout) from 4.2.0 to 4.2.1.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@d632683...eef6144)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
@bact bact added this to the 3.1 milestone Oct 18, 2024
@bact
Copy link
Collaborator

bact commented Oct 18, 2024

There's an error message from the spec-parser:

ERROR:root:Missing top-level namespace file Operations.md

@mkurzman
Copy link
Author

Is that spec-parser available to use locally in my repo, so that I could do a pre-commit or pre-PR check?

@bact
Copy link
Collaborator

bact commented Oct 18, 2024

Is that spec-parser available to use locally in my repo, so that I could do a pre-commit or pre-PR check?

It is available at https://github.com/spdx/spec-parser

For that particular error, it means that you need a file named Operations.md in model/Operations/ folder.

See for example model/Build/Build.md

--

Possible content of model/Operations/Operations.md:

SPDX-License-Identifier: Community-Spec-1.0

# Operations

## Summary

The Operations Profile defines ...

## Description

...

## Metadata

- id: https://spdx.org/rdf/3.1/terms/Operations
- name: Operations

## Profile Conformance

...

@bact
Copy link
Collaborator

bact commented Oct 18, 2024

Btw, we're drafting a document about the formatting and convention for model Markdown.

If you find anything that you think if you know about them before it will save your time writing the model file, please share them in #867 - Thank you

@mkurzman
Copy link
Author

Thank you for your hints. We will care about it.
Hint: My PR was not meant to be merged in master yet, but merged in the profile-operations branch first (as a kind of "dev-branch", where we collaboratively prepare our PR for main. Is this the right way to go or will this approach mess things up? If yes, please advise for an alternative approach.

@zvr
Copy link
Member

zvr commented Oct 21, 2024

This is the correct way of doing it, Marcel -- thanks!

@zvr zvr merged commit 2a71c84 into spdx:profile-operations Oct 21, 2024
1 check passed
@bact
Copy link
Collaborator

bact commented Oct 21, 2024

@mkurzman Note that if you like to see if the PR actually passed the validation, at this moment you have to click to look inside the workflow details (spec-parser currently returns 0 even if there is an error, so GitHub will think that there is no error and display "Green" checkmark).

For example, this is the output from the most recent validation
https://github.com/spdx/spdx-3-model/actions/runs/11434747090/job/31811598082#step:5:1

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

Successfully merging this pull request may close these issues.

4 participants