Skip to content

Fix erroneous pending migrations command

James Reed requested to merge docs-remove-erroneous-pending-migrations-cmd into master

What does this MR do and why?

This MR removes the Gitlab::BackgroundMigration.pending commands that appear to have been documented in error.

Attempting to run:

sudo gitlab-rails runner -e production 'puts Gitlab::BackgroundMigration.pending'

Will result in the output of:

Please specify a valid ruby command or the path of a script to run.

Alternatively, running this directly within the rails console will result in the following output:

irb(main):002:0> puts Gitlab::BackgroundMigration.pending;
Traceback (most recent call last):
        2: from (irb):1
        1: from (irb):2:in `rescue in irb_binding'
NoMethodError (undefined method `pending' for Gitlab::BackgroundMigration:Module)

There is no pending method defined within - https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/background_migration.rb - for the suggested commands to work.

It doesn't look like there is any history of a pending method having been added either:

$ git log -S pending -- lib/gitlab/background_migration.rb
$

Edit:

(Thanks @axil !)

As per !78242 (comment 810478663) - it looks like rather than a removal of the

Gitlab::BackgroundMigration.pending entries, we'll instead want to replace these with corrected Gitlab::Database::BackgroundMigrationJob.pending entries.

Gitlab::Database::BackgroundMigrationJob.pending does exist in https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/database/background_migration_job.rb

This aligns with the discussion and context of how/why this MR was originally raised - #334394 (comment 743743234)

Related issues

Author's checklist

If you are 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.

Review 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 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.
    • 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.
  • Ensure a release milestone is set.
Edited by James Reed

Merge request reports