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

Implement Best Practices Changes #41

Merged
merged 2 commits into from
Jan 4, 2024
Merged

Conversation

Jdubrick
Copy link
Contributor

@Jdubrick Jdubrick commented Jan 3, 2024

What does this PR do?

This PR adds the OpenSSF Best Practices Badge to the README file as well as exempts this repository from the ArtifactHub and License Scanning checks for the CLOMonitor. These checks are being exempted from almost all of our repositories.

Which issue(s) does this PR fix

fixes devfile/api#1384 (all but scorecard that is going to be added later)

PR acceptance criteria

Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.

  • Unit/Functional tests

  • Documentation

How to test changes / Special notes to the reviewer

Signed-off-by: Jordan Dubrick <jdubrick@redhat.com>
Signed-off-by: Jordan Dubrick <jdubrick@redhat.com>
@openshift-ci openshift-ci bot requested a review from elsony January 3, 2024 20:03
@openshift-ci openshift-ci bot added the approved label Jan 3, 2024
Copy link

codecov bot commented Jan 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8f277a2) 73.16% compared to head (f80e432) 73.16%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #41   +/-   ##
=======================================
  Coverage   73.16%   73.16%           
=======================================
  Files          11       11           
  Lines        1565     1565           
=======================================
  Hits         1145     1145           
  Misses        351      351           
  Partials       69       69           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@thepetk thepetk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
From what I found here & here it looks good to me. Out of curiosity I'd like to ask what are the criteria of choosing those specific exemptions (e.g license_scanning instead of others that are listed in the shared resources).

Copy link

openshift-ci bot commented Jan 4, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Jdubrick, thepetk

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Jdubrick
Copy link
Contributor Author

Jdubrick commented Jan 4, 2024

/lgtm From what I found here & here it looks good to me. Out of curiosity I'd like to ask what are the criteria of choosing those specific exemptions (e.g license_scanning instead of others that are listed in the shared resources).

Reasoning behind exempting the Artifact Hub and License Scanning checks were mainly due to this repository not having anything that should be hosted onto Artifact Hub, such as Helm Charts. As for License Scanning we don't have any of the services currently to support that and as they are paid we don't have any plan to implement them at this time.

What shared resources are you referring to?

@Jdubrick Jdubrick merged commit feaece4 into devfile:main Jan 4, 2024
6 checks passed
@thepetk
Copy link
Contributor

thepetk commented Jan 5, 2024

What shared resources are you referring to?

@Jdubrick I meant the two links in the comment :D

For the included checks it makes sense to me. But what was the criteria of selecting these two checks instead of others listed here: https://clomonitor.io/docs/topics/checks/

@Jdubrick
Copy link
Contributor Author

Jdubrick commented Jan 5, 2024

What shared resources are you referring to?

@Jdubrick I meant the two links in the comment :D

For the included checks it makes sense to me. But what was the criteria of selecting these two checks instead of others listed here: https://clomonitor.io/docs/topics/checks/

@thepetk Oh I understand now! The reason for choosing those two checks is because most of the others don't apply to this repository, we can view all the ones for Alizer here: https://clomonitor.io/projects/cncf/devfile#alizer. For the Cleaner tasks it includes the Documentation, License, and Best Practices Section.

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

Successfully merging this pull request may close these issues.

CNCF Cleaner Tasks for devfile/alizer
2 participants