Skip to content

Update docs to fix existing records before adding NOT NULL constraint

Abdul Wadood requested to merge abdwdd_doc_validate_only_changed_columns into master

What does this MR do?

This is a corrective action from a recent incident gitlab-com/gl-infra/production#16022 (comment 1466238135) where the new validations were failing on existing records.

Here we have changed the order of adding NOT NULL constraint and fixing existing records. According to the current changes, we first fix the existing records and when all records have been fixed we then add the NOT NULL constraint in the next milestone. We skip adding NOT VALID to the constraint because we check all records after waiting for a milestone and no code paths should be setting the column to null values then only we add the NOT NULL constraint.

Related issues

gitlab-com/gl-infra/production#16022 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Related issue #417917 (closed)

Edited by Abdul Wadood

Merge request reports