[Devtools] CNCF Cleaner Tasks #258
Conversation
Signed-off-by: Jordan Dubrick <[email protected]>
Signed-off-by: Jordan Dubrick <[email protected]>
Signed-off-by: Jordan Dubrick <[email protected]>
There was a problem hiding this comment.
In most of our docs we have been linking to the code of conduct and governance under devfile/api:
- https://github.com/devfile/api/blob/e37cd6b0b4ac21524a724e68373746393b91b9ed/CODE_OF_CONDUCT.md
- https://github.com/devfile/api/blob/e37cd6b0b4ac21524a724e68373746393b91b9ed/GOVERNANCE.md
@maysunfaisal Does CLO scanning require this to be directly in the repository?
I think we may be able to just link from the readme to the code of conduct and governance. Initially I think I may have misunderstood the requirements but it may just be the file has to be in the repo OR a section in the readme for it |
Signed-off-by: Jordan Dubrick <[email protected]>
Signed-off-by: Jordan Dubrick <[email protected]>
If the files are needed in each repository, a middle ground alternative is we could provide links in the repository code of conduct and governance documents to the devfile/api project documents to still remove the need to update this information in many places. |
Signed-off-by: Jordan Dubrick <[email protected]>
|
I made changes based off your suggestions, I believe linking out from the readme will be sufficient because the header is there in the readme and it will check for that. So far I have only found Odo as a user but will add more as I find it, this PR isn't mergeable yet as I still need to add a few more tasks |
|
There are 2 tasks as part of this issue that I believe should be marked as exempt from the checks: As we keep everything in devfile/api that also means we only have discussions enabled for that repo as well. Additionally, for the trademark it states that it doesn't work with dynamic sites (React, Angular, etc) and since our devfile-web is built with Next.js I believe that falls under React. @michael-valdron @maysunfaisal what do you think? |
|
@Jdubrick I am okay with those checks being skipped here! |
Signed-off-by: Jordan Dubrick <[email protected]>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Jdubrick, maysunfaisal, michael-valdron The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What does this PR do?:
Summarize the changes. Are any stacks or samples added or updated?
These changes aim to increase the CLO Monitor score for devfile/registry as part of the CNCF Cleaner badge
Which issue(s) this PR fixes:
Link to github issue(s)
Works to resolve tasks outlined in devfile/api#1368
PR acceptance criteria:
Have you read the devfile registry contributing guide and followed its instructions?
Does this repository's tests pass with your changes?
Does any documentation need to be updated with your changes?
Have you tested the changes with existing tools, i.e. Odo, Che, Console? (See devfile registry contributing guide on how to test changes)
How to test changes / Special notes to the reviewer: