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

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

Closed
wants to merge 18 commits into from
Closed

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

wants to merge 18 commits into from

Commits on Jun 10, 2024

  1. Update README.md: build instructions and flow 

    - 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>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    3fd5b0b View commit details
    Browse the repository at this point in the history

  2. Update index.md 

    Add missing SPDX-lite contributor

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @kestewart @bact
    kestewart authored and bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    2fd79ce View commit details
    Browse the repository at this point in the history

  3. Fix typo: SpecVerion, interoperabiility 

    - SpecVerion -> SpecVersion
- interoperabiility -> interoperability
- remove trailing white spaces at the end of line

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    0d4153f View commit details
    Browse the repository at this point in the history

  4. mkdocs: Fix ref not found warnings 

    A rework of spdx#926 to fix unresolvable merge conflicts

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    f292ab8 View commit details
    Browse the repository at this point in the history

  5. Retain original long paragraph 

    Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    4bf31ae View commit details
    Browse the repository at this point in the history

  6. Retaining original long paragraph 

    Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    9acd79b View commit details
    Browse the repository at this point in the history

  7. Remove ontology directory 

    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>
    @JPEWdev @bact
    JPEWdev authored and bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    d992238 View commit details
    Browse the repository at this point in the history

  8. docs: annex: getting-started: Add missing reference 

    Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @JPEWdev @bact
    JPEWdev authored and bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    8a2456e View commit details
    Browse the repository at this point in the history

  9. doc: annex: Validate documentation examples 

    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>
    @JPEWdev @bact
    JPEWdev authored and bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    557d7cb View commit details
    Browse the repository at this point in the history

  10. Add annex describing how to cross reference documents 

    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>
    @JPEWdev @bact
    JPEWdev authored and bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    001ddb9 View commit details
    Browse the repository at this point in the history

  11. Fixes ABNF for license expressions 

    Signed-off-by: Alexios Zavras <github@zvr.gr>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @zvr @bact
    zvr authored and bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    8756855 View commit details
    Browse the repository at this point in the history

  12. Remove ontology/ directory 

    Also put label to the flow diagram

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    8275276 View commit details
    Browse the repository at this point in the history

  13. Add a note on Constrained-Markdown format 

    Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    b54c30e View commit details
    Browse the repository at this point in the history

  14. Add a section about configuration 

    Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    67e52b6 View commit details
    Browse the repository at this point in the history

  15. Validate only specific doc examples with SHACL in CI. 

    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
    Jeff Licquia authored and bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    1261b95 View commit details
    Browse the repository at this point in the history

  16. Merge branch 'development/v3.0.1' into update-build-instruct-flow

    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    2216d1c View commit details
    Browse the repository at this point in the history

  17. Reset the branch to fix non-sign-off 

    Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    503b026 View commit details
    Browse the repository at this point in the history

  18. Merge branch 'update-build-instruct-flow' of https://github.com/bact/… 

    …spdx-spec into update-build-instruct-flow
    @bact
    bact committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    2a6c295 View commit details
    Browse the repository at this point in the history