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 Testing Documentation #88

Merged
merged 5 commits into from
Apr 16, 2024

Conversation

Jdubrick
Copy link
Contributor

Please specify the area for this PR
Documentation updates

What does does this PR do / why we need it:
This PR updates the documentation for how to properly test the Devfile Registry Operator. This also updates the PR template to include these instructions so reviewers will always have that information readily available.

Which issue(s) this PR fixes:

No issue

PR acceptance criteria:

  • Test Coverage
    • Are your changes sufficiently tested, and are any applicable test cases added or updated to cover your changes?
  • Gosec scans

Documentation

  • Does the registry operator documentation need to be updated with your changes?

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>
Signed-off-by: Jordan Dubrick <jdubrick@redhat.com>
Copy link
Member

@michael-valdron michael-valdron left a comment

Choose a reason for hiding this comment

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

Changes looks good.

We should include a note for the integration test instructions stating this is subject to change when devfile/api#1523 is resolved.

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

Changes looks good.

We should include a note for the integration test instructions stating this is subject to change when devfile/api#1523 is resolved.

I added a comment as a reminder.

Copy link
Member

@michael-valdron michael-valdron left a comment

Choose a reason for hiding this comment

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

/lgtm

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.

Left a minor comment

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
Signed-off-by: Jordan Dubrick <jdubrick@redhat.com>
@openshift-ci openshift-ci bot removed the lgtm label Apr 16, 2024
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

Copy link

openshift-ci bot commented Apr 16, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Jdubrick, michael-valdron, 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:
  • OWNERS [Jdubrick,michael-valdron,thepetk]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Jdubrick Jdubrick merged commit eff2b64 into devfile:main Apr 16, 2024
9 checks passed
thepetk pushed a commit to thepetk/devfile-registry-operator that referenced this pull request Aug 20, 2024
* update documentation for testing the operator

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

* update pr template for testing changes

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

* make reference to files consistent cases

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

* add comment as reminder to update docs

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

* link test instructions in pr template to contributing

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

---------

Signed-off-by: Jordan Dubrick <jdubrick@redhat.com>
Signed-off-by: thepetk <thepetk@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants