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

Example filenames should be lower case?! #508

Closed
bernhardreiter opened this issue Apr 7, 2022 · 3 comments
Closed

Example filenames should be lower case?! #508

bernhardreiter opened this issue Apr 7, 2022 · 3 comments
Assignees
@sthagen @tschmidtb51
Labels
editorial mostly nits and consistency

Comments

@bernhardreiter
Copy link
Contributor

The csaf 2.0 filenames for the examples (as of this moment) are:

BSI-2022-0001.json
CVE-2018-0171-modified.json
cvrf-rhba-2018-0489-modified.json

(https://github.com/oasis-tcs/csaf/tree/f5be5c83d34c24b732f01c054f6d65285922d8a0/csaf_2.0/examples)

According to https://docs.oasis-open.org/csaf/csaf/v2.0/cs01/csaf-v2.0-cs01.html#51-filename , shouldn't they all be lower case?
@bernhardreiter
Copy link
Contributor Author

bernhardreiter commented Apr 7, 2022 •
edited
Loading

https://github.com/oasis-tcs/csaf/tree/master/csaf_2.0/test/validator/data has many upper case filenames as well. (Somehow I feel like I am missing something here.)

@bernhardreiter bernhardreiter mentioned this issue Apr 7, 2022
Closed
@sthagen
Copy link
Contributor

sthagen commented Apr 7, 2022

@bernhardreiter I think we were missing to simplify the names as a coordinated task before producing editor revisions in PRs for adoption by the TC. @tschmidtb51 I suggest we use this feedback (issue) as feedback from public review and can then be confident that changes we do based on this feedback are considered non-material by the TC so we can ensure the CS02 (presumably following the CSD02/PRSD02) will receive these enhancements (and the repository for the parts not delivered to docs.oasis-open.org)

@sthagen sthagen added the editorial mostly nits and consistency label Apr 7, 2022
tschmidtb51 added a commit to tschmidtb51/csaf that referenced this issue Apr 11, 2022
@tschmidtb51
Filenames
687c67b 
- addresses parts of oasis-tcs#508
- add script to test filenames of CSAF files
- add Github Action to run test script
tschmidtb51 added a commit to tschmidtb51/csaf that referenced this issue Apr 11, 2022
@tschmidtb51
Filenames
715230b 
- addresses parts of oasis-tcs#508
- rename CSAF examples
- fix filenames of test files
@tschmidtb51 tschmidtb51 mentioned this issue Apr 11, 2022
Merged
tschmidtb51 added a commit to tschmidtb51/csaf that referenced this issue Apr 11, 2022
@tschmidtb51
Filenames
3fa7689 
- addresses parts of oasis-tcs#508
- update filename of template
- adopt exclude list in validator run-script
@tschmidtb51
Copy link
Contributor

This issue has been resolved and filename test has been added to check filenames an prevent mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sthagen sthagen

@tschmidtb51 tschmidtb51

Labels
editorial mostly nits and consistency
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sthagen @bernhardreiter @tschmidtb51