Skip to content

Add upgrade notes for the fix on group updates

David Fernandez requested to merge 419289-upgrade-notes into master

📖 What does this MR do?

These are the accompanying upgrade notes for #419289 (closed).

In short words:

  • We created a fix regarding group path updates that contain NPM packages. This fix required a new database index.
  • Due to the nature of that new database index, we needed to following timeline:
    1. Index created
    2. ANALYZE packages_packages; executed.
    3. Index can be used (the fix can be applied).
  • To have more control on that timeline, we used a feature flag (see the discussion here). The idea is basically:
    1. In milestone m, introduce the index and the feature flag. We did this in %16.3
    2. In milestone m+1, remove the feature flag. We did this in %16.4
  • gitlab.com is not affected by this since we could wait the ANALYZE execution before rolling out the feature flag.
  • self-managed can be impacted. If they follow the releases: 16.3.0 -> 16.4.0, there are high chances that the ANALYZE will happen between the index creation and %16.4.

The risk here is for self-managed that will upgrade their setup "skipping" %16.3. For example, going from %16.2 to %16.4.

To mitigate this, this MR introduces upgrade notes that described that an ANALYZE query is required for %16.4.

Related issues

#419289 (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.

Merge request reports