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

Update CI for new spec-parser output #1066

Closed
Tracked by #1094
zvr opened this issue Aug 13, 2024 · 9 comments · Fixed by #1113
Closed
Tracked by #1094

Update CI for new spec-parser output #1066

zvr opened this issue Aug 13, 2024 · 9 comments · Fixed by #1113
Milestone

Comments

@zvr
Copy link
Member

zvr commented Aug 13, 2024

@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 zvr added the publishing label Aug 13, 2024
@bact
Copy link
Collaborator

bact commented Aug 13, 2024

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

@zvr
Copy link
Member Author

zvr commented Aug 30, 2024

@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).

@bact
Copy link
Collaborator

bact commented Aug 30, 2024

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
Copy link
Collaborator

bact commented Aug 30, 2024

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.

@zvr
Copy link
Member Author

zvr commented Aug 30, 2024

OK, do we want to do a synchronized update?

@bact bact mentioned this issue Sep 2, 2024
6 tasks
@bact
Copy link
Collaborator

bact commented Sep 5, 2024

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.

@zvr
Copy link
Member Author

zvr commented Sep 5, 2024

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.

@bact
Copy link
Collaborator

bact commented Sep 5, 2024

Thank you. I will standby.

@bact
Copy link
Collaborator

bact commented Sep 7, 2024

Note, #1113 is now using this new structure

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

Successfully merging a pull request may close this issue.

2 participants