Skip to content

Docs on adding/removing args from Sidekiq workers/mailers

Drew Blessing requested to merge dblessing-add-sidekiq-mailer-argument-docs into master

What does this MR do?

Hopes to prevent future issues like #220039 (closed).

Adding or removing arguments from existing Sidekiq workers or mailers can lead to wrong number of arguments errors in production during deployments prior to all nodes having the updated code. These docs provide guidance on how to add or remove arguments safely.

Related issues

#220039 (closed)

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Mike Jang

Merge request reports