Skip to content

Update docs to disable rule in DB guides example

Krasimir Angelov requested to merge update-docs-example-for-adding-fk-docs into master

What does this MR do?

In the example for "Creating a new table when we have two foreign keys" we recommend using add_foreign_key - https://docs.gitlab.com/ee/development/migration_style_guide.html#examples.

We also have a Rubocop rule that warns against its usage - https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/cop/migration/add_concurrent_foreign_key.rb. This can cause confusion, recent example here - !41785 (comment 411886303).

This updates the examples too disable this rule. Alternatively we can start recommending add_concurrent_foreign_key to be used everywhere, even if the table is newly created and empty.

Screenshots

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Krasimir Angelov

Merge request reports

Loading