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

chore: give best practices around mutations #1672

Merged
merged 11 commits into from
Jan 21, 2025
Merged

chore: give best practices around mutations #1672

merged 11 commits into from
Jan 21, 2025

Conversation

cmwylie19
Copy link
Collaborator

Description

Provide documentation/education on why it is a best practice to always Validate any Mutations.

Related Issue

Fixes #899

Relates to #

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@cmwylie19 cmwylie19 requested a review from a team as a code owner January 15, 2025 22:20
Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.52%. Comparing base (7d4df9d) to head (39ca452).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1672   +/-   ##
=======================================
  Coverage   79.52%   79.52%           
=======================================
  Files          48       48           
  Lines        2090     2090           
  Branches      461      452    -9     
=======================================
  Hits         1662     1662           
  Misses        398      398           
  Partials       30       30           

Copy link
Collaborator

@btlghrants btlghrants left a comment

Choose a reason for hiding this comment

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

I suggested a couple of links & call-outs the one of the config traps that led to us wanting to add this write-up.

Feel free to move it around / re-write those as you will -- just wanted to be sure we had some actionable links / descriptions of how someone might get themselves into trouble by not validating.

docs/060_best-practices/README.md Outdated Show resolved Hide resolved
docs/060_best-practices/README.md Outdated Show resolved Hide resolved
docs/060_best-practices/README.md Outdated Show resolved Hide resolved
docs/060_best-practices/README.md Outdated Show resolved Hide resolved
samayer12
samayer12 previously approved these changes Jan 16, 2025
Copy link
Collaborator

@samayer12 samayer12 left a comment

Choose a reason for hiding this comment

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

Good PR on mutations. Used this as the basis for a Pepr tip on 16 Jan 2025.

docs/060_best-practices/README.md Outdated Show resolved Hide resolved
docs/060_best-practices/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@btlghrants btlghrants left a comment

Choose a reason for hiding this comment

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

Seems right enough to me.

@cmwylie19 cmwylie19 enabled auto-merge January 21, 2025 20:09
@cmwylie19 cmwylie19 added this pull request to the merge queue Jan 21, 2025
Merged via the queue into main with commit af0a71a Jan 21, 2025
47 of 48 checks passed
@cmwylie19 cmwylie19 deleted the 899 branch January 21, 2025 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Mutating webhooks should not continue if a handler throws..?
3 participants