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 CRD versioning developer doc #2404

Merged
merged 5 commits into from
Aug 20, 2024
Merged

Conversation

sjberman
Copy link
Contributor

Problem: We need a developer doc that explains how our CRDs are versioned and what constitutes a version change.

Solution: Add a doc describing the criteria for this process.

Closes #936

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NONE

@sjberman sjberman requested review from a team as code owners August 15, 2024 14:52
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 15, 2024
Copy link
Contributor

@salonichf5 salonichf5 left a comment

Choose a reason for hiding this comment

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

lgtm

docs/developer/crd-versioning.md Show resolved Hide resolved
docs/developer/crd-versioning.md Show resolved Hide resolved
docs/developer/crd-versioning.md Show resolved Hide resolved
Copy link

codecov bot commented Aug 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.84%. Comparing base (114275c) to head (e9accc3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2404   +/-   ##
=======================================
  Coverage   88.84%   88.84%           
=======================================
  Files         100      100           
  Lines        7527     7527           
  Branches       50       50           
=======================================
  Hits         6687     6687           
  Misses        784      784           
  Partials       56       56           

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

Problem: We need a developer doc that explains how our CRDs are versioned and what constitutes a version change.

Solution: Add a doc describing the criteria for this process.
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

A few suggestions, otherwise LGTM.

Very clear.

docs/developer/crd-versioning.md Show resolved Hide resolved
docs/developer/crd-versioning.md Outdated Show resolved Hide resolved
docs/developer/crd-versioning.md Outdated Show resolved Hide resolved
@sjberman sjberman enabled auto-merge (squash) August 20, 2024 20:52
@sjberman sjberman merged commit 9660272 into nginxinc:main Aug 20, 2024
36 of 37 checks passed
@sjberman sjberman deleted the docs/crd-versioning branch August 20, 2024 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Document CRD versioning
6 participants