Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(batch): deprecate sqs_batch_processor #1463

Conversation

rubenfonseca
Copy link
Contributor

Issue number: #1459

Summary

Changes

Please provide a summary of what's being changed

This PR adds a deprecation warning to the sqs_batch_processor decorator and PartialSQSProcessor class.

It also adds a banner on the documentation urging customers to upgrade before the next major version.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 19, 2022
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Aug 19, 2022
@rubenfonseca rubenfonseca marked this pull request as ready for review August 19, 2022 12:25
@rubenfonseca rubenfonseca requested a review from a team as a code owner August 19, 2022 12:25
@rubenfonseca rubenfonseca requested review from heitorlessa and removed request for a team August 19, 2022 12:25
@rubenfonseca
Copy link
Contributor Author

@heitorlessa I do not know if the way I've implemented the banner on the docs is the correct way to do it.

@github-actions github-actions bot added the internal Maintenance changes label Aug 19, 2022
Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Two notes on repurposing announcement bar to inform customers of v2, and admonition for batch.md

aws_lambda_powertools/utilities/batch/sqs.py Outdated Show resolved Hide resolved
@@ -1,5 +1,10 @@
{% extends "base.html" %}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would add an announcement for the entire documentation, we'd want under batch.md instead with admonition:

???+ warning
    our message...

This type of announcement will be super useful to let people know we're going to launch v2. So perhaps rephrase to inform them that? I think it'll also need to make it auto-hide so those who already seen don't see it again: https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/?h=announcement#automatic-hiding

@rubenfonseca
Copy link
Contributor Author

Moved the warning to the batch doc page, and added a banner to documentation saying "v2 is coming". As always, feedback on wording is very important to me.

@heitorlessa heitorlessa merged commit 54c051d into aws-powertools:develop Aug 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal Maintenance changes size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants