spdx-spec icon indicating copy to clipboard operation
spdx-spec copied to clipboard

Update CI for new spec-parser output

Open zvr opened this issue 1 year ago • 1 comments

@bact a heads-up! The spec-parser now outputs the generated files in a different directory structure.

If it is run via python3 /some/dir/spec-parser/main.py /somewhere/spdx-3-model/model /generate/outputdir

it will generate outputdir and its contents will be:

.
├── diagram
│   └── model.plantuml
├── jsondump
│   └── model.json
├── mkdocs
│   ├── AI
│   │   ├── AI.md
│   │   ├── Classes
│   │   │   ├── AIPackage.md
...
├── model-files.tex
├── model-files.yml
├── rdf
│   ├── spdx-context.jsonld
│   ├── spdx-model.dot
│   ├── spdx-model.json-ld
│   ├── spdx-model.pretty-xml
│   ├── spdx-model.ttl
│   └── spdx-model.xml
└── tex
    ├── AI
    │   ├── AI.tex
    │   ├── Classes
    │   │   ├── AIPackage.tex
...

Note the new location for everything RDF (the ontology as well as the context) and new names for files list (to be included in the mkdocs configuration) and generated md files. Also note that the files list uses the old top-level directory name. If the tree is not copied, I can be easily change this in spec-parser.

zvr avatar Aug 13 '24 12:08 zvr

@zvr Thank you for a very detailed info. I will adjust accordingly.

bact avatar Aug 13 '24 14:08 bact

@bact any progress on handling this one?

The sooner it's ready, the sooner I can merge the changes to spec-parser, so that further collaborative development can be done (since I've notices a couple of issues raised by @goneall there).

zvr avatar Aug 30 '24 13:08 zvr

The propose change is in #1100 but it still using the old structure since it's relying on the current spec-paser - as if it uses the new dir structure, it will not pass the checks.

Once spec-paser merges the changes, we can:

  1. pause updates in spdx-spec rep
  2. update Line 22-23
  3. run the CI
  4. unpause the updates in spdx-spec repo

bact avatar Aug 30 '24 13:08 bact

Btw, if we like to keep the old structure of pre-3.0.1 publication, we may need to update publication workflow in development/v3.0 branch to use a specific version (commit hash, release tag, etc) of spec-parser before the dir changes.

Or, alternatively, modify the development/v3.0 workflow to copy files from new dirs to old dirs.

bact avatar Aug 30 '24 13:08 bact

OK, do we want to do a synchronized update?

zvr avatar Aug 30 '24 14:08 zvr

OK, do we want to do a synchronized update?

@zvr When #1100 got another approval (to make it two approvals), I think we are good to go.

bact avatar Sep 05 '24 08:09 bact

Thanks, @bact. I'll probably merge bith #1100 and the new spec-parser later today or early tomorrow, so we have time to fix any issues that arise before the weekend.

zvr avatar Sep 05 '24 14:09 zvr

Thank you. I will standby.

bact avatar Sep 05 '24 15:09 bact

Note, #1113 is now using this new structure

bact avatar Sep 07 '24 21:09 bact