UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Closed Codeowner Deep Dives
  • View options
  • Codeowner Deep Dives

  • View options
  • Closed Epic created by Micah Nagel

    As a codeowner your primary responsibilities are:

    • Reviewing/testing merge requests for your particular package
    • Triaging issues that come in for your particular package (identifying if there are bugs, updates needed, severity etc)
    • (TBD) handling most updates to your package (working Renovate updates, other package improvements)

    You will need to deep dive into your package to understand a number of things, including:

    • What is the package's functionality within Big Bang? What is the general architecture of the package?
    • Does the package have high availability/clustering? If so, how does it function/what does it require? Note: you may find this in the architecture doc within Big Bang.
    • How does the BB package differ from the upstream version (if applicable)?
    • What does adequate testing of the package look like? What does the pipeline currently test?
    • Where should you look for package updates and new interesting features to pull into BB?

    Most of these things should also be captured to some extent in the dev docs for the package. As you work through the above, and other deep diving, capture key take aways in the docs/DEVELOPMENT_MAINTENANCE.md document. The general format of that document includes 3 sections currently, but can be expanded to fit the necessary information:

    • How to handle an upgrade to the chart (focused specifically on how to perform the necessary code changes)
    • How to test an upgrade to the chart
    • What the differences between BB's chart and the upstream are

    The specific outputs of this issue should be:

    • Update to/creation of a docs/DEVELOPMENT_MAINTENANCE.md document
      • If you need to create a docs/DEVELOPMENT_MAINTENCE.md, some examples to follow are Vault , fluentbit , and GitLab
    • Creation of issues (as necessary) to improve the pipeline testing to match what would be required for fully automated confidence in an update
    • Additional "learning notes" on how you went about diving into the package and what you learned
    • (fuzzy) ability to help someone with a question about your package, ability to review an MR that comes in for your package, ability to present in a "T3-like" format to explain/demo your package

    You should feel comfortable handling your codeowner duties after completing this deep dive.

    To keep tract of who has done a deep dive on which packages, please make an issue following the format below - Make a new issue under Codeowner Deep Dives Epic

        - Title: [Package Name] [Your Name] Codeowner Deep Dive 
        - weight: 1 
        - iteration: current iteration
        - Attach the issue to this epic
        - Tags: Kind::Chore team::bigbang 
    Edited by Mark Nelson

    Linked items 0

  • Link items together to show that they're related or that one is blocking others.

    Activity

    • All activity
    • Comments only
    • History only
    • Newest first
    • Oldest first
    Loading Loading Loading Loading Loading Loading Loading Loading Loading Loading