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

[Devtools] Add Security Insights for CNCF #1236

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Jdubrick
Copy link
Contributor

@Jdubrick Jdubrick commented Mar 1, 2024

What does this PR do?

This PR adds the SECURITY-INSIGHTS.yml file that is required as part of devfile/api#1396. This is due to an effort to increase our score on the CLOMonitor where we are actively trying to improve our repositories and adhere to open source best practices. The addition of this file will provide the monitor with valuable information such as current release, licensing, repo activity status, current maintainers, contributing policy and dependencies.

What issues does this PR fix or reference?

fixes devfile/api#1396

Is it tested? How?

No testing required the file does not alter the way the project works.

PR Checklist

  • E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)
    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che

Signed-off-by: Jordan Dubrick <jdubrick@redhat.com>
Copy link

openshift-ci bot commented Mar 1, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Jdubrick
Once this PR has been reviewed and has the lgtm label, please assign aobuchow for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

Copy link
Collaborator

@AObuchow AObuchow left a comment

Choose a reason for hiding this comment

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

@Jdubrick Thank you for the PR :) I added some comments for clarification on certain details.

Is there a link to the schema for SECURITY-INSIGHTS.yml that I should consult?

last-reviewed: '2024-03-01'
expiration-date: '2025-03-01T10:00:00.000Z'
project-url: https://github.com/devfile/devworkspace-operator
project-release: '0.26.0'
Copy link
Collaborator

Choose a reason for hiding this comment

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

I assume this needs to be updated at every release of DWO?

expiration-date: '2025-03-01T10:00:00.000Z'
project-url: https://github.com/devfile/devworkspace-operator
project-release: '0.26.0'
commit-hash: '067847d900c18a3fe0d47de920a9ce77af29e722'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this commit hash supposed to relate to the released version (i.e. 0.26.0) or the latest commit on the main branch?

core-maintainers:
- github:AObuchow
- github:dkwon17
release-cycle: https://github.com/devfile/devworkspace-operator/blob/main/docs/release/README.md
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not entirely sure if this field is supposed to point to the release documentation or the release cadence? We usually release DWO upstream in advance of an Eclipse Che release, as Eclipse Che depends on DWO.

SECURITY-INSIGHTS.yml Show resolved Hide resolved
SECURITY-INSIGHTS.yml Outdated Show resolved Hide resolved
Signed-off-by: Jordan Dubrick <jdubrick@redhat.com>
@Jdubrick
Copy link
Contributor Author

Jdubrick commented Mar 1, 2024

@Jdubrick Thank you for the PR :) I added some comments for clarification on certain details.

Is there a link to the schema for SECURITY-INSIGHTS.yml that I should consult?

Hey Andrew that is my fault, I forgot to include the link in my description. You can find it here: https://github.com/ossf/security-insights-spec/blob/main/specification.md

To answer your comments:

  1. project-release is just the release number that the SECURITY-INSIGHTS.yml file is confirmed to cover, I believe you can release and not update the insights but then it would technically be 'outdated'.

  2. commit-hash is the last commit that the SECURITY-INSIGHTS.yml file covers.

  3. Yes that is correct it should point to the cycle, is there a better link that I should place there?

@Jdubrick
Copy link
Contributor Author

Jdubrick commented Mar 1, 2024

@Jdubrick Thank you for the PR :) I added some comments for clarification on certain details.
Is there a link to the schema for SECURITY-INSIGHTS.yml that I should consult?

Hey Andrew that is my fault, I forgot to include the link in my description. You can find it here: https://github.com/ossf/security-insights-spec/blob/main/specification.md

To answer your comments:

  1. project-release is just the release number that the SECURITY-INSIGHTS.yml file is confirmed to cover, I believe you can release and not update the insights but then it would technically be 'outdated'.
  2. commit-hash is the last commit that the SECURITY-INSIGHTS.yml file covers.
  3. Yes that is correct it should point to the cycle, is there a better link that I should place there?

As we are currently working through this to add the insight file to Devfile repos can we place this PR on hold until it is fully hashed out? Noticing issues related to certain fields in one of our other repos.

cc @AObuchow

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

Successfully merging this pull request may close these issues.

CNCF Defender Tasks for devworkspace-operator
2 participants