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

Add some in-code architecture docs #753

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

KevinMGranger
Copy link
Collaborator

@KevinMGranger KevinMGranger commented Dec 19, 2022

Depends on the committime PR, ignore those changes for now.

Signed-off-by: Kevin M Granger <kgranger@redhat.com>
…mework

Signed-off-by: Kevin M Granger <kgranger@redhat.com>
- fixes using items with just `__getitem__` as deserialization sources
  for classes
- adds support for keeping the deserialization source as a field
  (useful for large objects you still want to work with dynamically)

Signed-off-by: Kevin M Granger <kgranger@redhat.com>
There were several typing issues and unclear APIs in the committime exporter.

CommitMetric was used as a big blob.
It carried all inputs and outputs, with almost no guarantees for
when and where things would be set. It also had several unused fields.

The way it was meant to be handled by implementors was also unclear:

do they modify it on the passed in CommitMetric?
do they return a CommitMetric with the committime updated?
what if they return None?
what if the information needed is missing?
There are several spots where a type checker would complain.
Including some spots where the variable being used could be unbound!

Signed-off-by: Kevin M Granger <kgranger@redhat.com>
Signed-off-by: Kevin M Granger <kgranger@redhat.com>
Signed-off-by: Kevin M Granger <kgranger@redhat.com>
Signed-off-by: Kevin M Granger <kgranger@redhat.com>
Signed-off-by: Kevin M Granger <kgranger@redhat.com>
Signed-off-by: Kevin M Granger <kgranger@redhat.com>
Signed-off-by: Kevin M Granger <kgranger@redhat.com>
@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes labels Dec 19, 2022
@openshift-ci
Copy link

openshift-ci bot commented Dec 19, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from kevinmgranger by writing /assign @kevinmgranger in a comment. 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

@openshift-ci
Copy link

openshift-ci bot commented Dec 19, 2022

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 20, 2022
@openshift-merge-robot
Copy link
Collaborator

@KevinMGranger: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@mateusoliveira43 mateusoliveira43 added the docs Documentation issue label Jan 4, 2023
Signed-off-by: Kevin M Granger <kgranger@redhat.com>
@KevinMGranger KevinMGranger changed the title Add architecture docs Add some in-code architecture docs Feb 4, 2023
@mateusoliveira43
Copy link
Collaborator

@KevinMGranger can you update the PR description to link which PR this one depends on? (put depends on #NUMBER in it so dpulls job knows about it)

@mateusoliveira43 mateusoliveira43 self-assigned this May 5, 2023
@mateusoliveira43 mateusoliveira43 removed their assignment Jun 9, 2023
Copy link

openshift-ci bot commented Sep 9, 2024

@KevinMGranger: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/4.12-e2e-openshift ea0acef link true /test 4.12-e2e-openshift
ci/prow/4.13-e2e-openshift ea0acef link true /test 4.13-e2e-openshift

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dco-signoff: yes do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. docs Documentation issue needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants