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

README.md: Update build instructions and add build flow diagram #946

Closed
wants to merge 18 commits into from

Conversation

bact
Copy link
Contributor

@bact bact commented Apr 27, 2024

Please use #971 instead

@bact bact changed the title Update README.md: build instructions and flow README.md: Update build instructions and flow Apr 27, 2024
@bact bact changed the title README.md: Update build instructions and flow README.md: Update build instructions and add build flow diagram Apr 28, 2024
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 - Thanks @bact

@goneall goneall added this to the 3.0.1 milestone Apr 30, 2024
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 - Note: we should update the "current version" to 3.0.1, but it doesn't look like we're generating the spec for that version. This can be done as a separate PR.

README.md Outdated Show resolved Hide resolved
@bact bact requested a review from JPEWdev June 4, 2024 18:38
bact and others added 15 commits June 10, 2024 19:09
- Update info about development branch and repo
- Update spec structure with additional info on repo structure
- Update build instructions
- Add build flow diagram

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Add missing SPDX-lite contributor

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
- SpecVerion -> SpecVersion
- interoperabiility -> interoperability
- remove trailing white spaces at the end of line

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
A rework of spdx#926 to fix unresolvable merge conflicts

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
These are not kept up to date (the actual files are in the GitHub
pages), and having them here confuses people

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Updates the security information Annex to conform to the SPDX 3.0 schema
and model. In addition, the CI workflow is updated to use a standalone
script to do the validation (making it easier to validate locally). When
validation documentation files, the script will now detect if the
documentation is a complete document or just fragements of a document.
In the latter case, a wrapper is made around the JSON from the
documentation to make it a valid document for validation (e.g.
"@context", "@graph", and a CreationInfo).

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Adds a markdown document with examples that explains how to refer to
elements across documents

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Alexios Zavras <github@zvr.gr>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Also put label to the flow diagram

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
The check assumes that JSON example snippets are all parts of a single
JSON document that needs validating, but not all files are written
that way.  To avoid errors that have nothing to do with the
correctness of the examples, we should only check files which meet the
check's assumptions.

Fixes spdx#912.

Signed-off-by: Jeff Licquia <jeff@licquia.org>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact force-pushed the update-build-instruct-flow branch from d28570a to 67e52b6 Compare June 10, 2024 18:09
@bact
Copy link
Contributor Author

bact commented Jun 10, 2024

There are resolvable conflicts. I will close this. New PR with updates is at #971.

@bact bact closed this Jun 10, 2024
@bact bact deleted the update-build-instruct-flow branch June 15, 2024 21:04
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.

None yet

5 participants