From a748c6520f8ed4cc7557996c581210280fa4a60d Mon Sep 17 00:00:00 2001 From: Kieran Brantner-Magee Date: Mon, 5 Oct 2020 11:26:24 -0700 Subject: [PATCH 1/4] b7 release doc fixes (link changes to newest preview permalink, release date in changelog) --- sdk/servicebus/azure-servicebus/CHANGELOG.md | 2 +- sdk/servicebus/azure-servicebus/README.md | 2 +- sdk/servicebus/azure-servicebus/migration_guide.md | 12 ++++++------ 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/sdk/servicebus/azure-servicebus/CHANGELOG.md b/sdk/servicebus/azure-servicebus/CHANGELOG.md index 1eef9e64738d..0a2e2aa167d8 100644 --- a/sdk/servicebus/azure-servicebus/CHANGELOG.md +++ b/sdk/servicebus/azure-servicebus/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 7.0.0b7 (Unreleased) +## 7.0.0b7 (2020-10-05) **Breaking Changes** * Passing any type other than `ReceiveMode` as parameter `receive_mode` now throws a `TypeError` instead of `AttributeError`. diff --git a/sdk/servicebus/azure-servicebus/README.md b/sdk/servicebus/azure-servicebus/README.md index aea2a347484a..64a0069419de 100644 --- a/sdk/servicebus/azure-servicebus/README.md +++ b/sdk/servicebus/azure-servicebus/README.md @@ -410,7 +410,7 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio [cloud_shell]: https://docs.microsoft.com/azure/cloud-shell/overview [cloud_shell_bash]: https://shell.azure.com/bash [pip]: https://pypi.org/project/pip/ -[pypi]: https://pypi.org/project/azure-servicebus/7.0.0b6/ +[pypi]: https://pypi.org/project/azure-servicebus/7.0.0b7/ [python]: https://www.python.org/downloads/ [venv]: https://docs.python.org/3/library/venv.html [virtualenv]: https://virtualenv.pypa.io diff --git a/sdk/servicebus/azure-servicebus/migration_guide.md b/sdk/servicebus/azure-servicebus/migration_guide.md index 67ad0166e96d..bba5899c1fc6 100644 --- a/sdk/servicebus/azure-servicebus/migration_guide.md +++ b/sdk/servicebus/azure-servicebus/migration_guide.md @@ -14,12 +14,12 @@ Note: The large version gap is in order to normalize service bus SDK versions ac ### Specific clients for sending and receiving In v7 we've simplified the API surface, making two distinct clients, rather than one for each of queue, topic, and subscription: -* `ServiceBusSender` for sending messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.html#azure.servicebus.ServiceBusSender) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSender) -* `ServiceBusReceiver` for receiving messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.html#azure.servicebus.ServiceBusReceiver) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusReceiver) -* `ServiceBusSessionReceiver` for receiving messages from a session. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.html#azure.servicebus.ServiceBusSessionReceiver) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b4/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSessionReceiver) +* `ServiceBusSender` for sending messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.html#azure.servicebus.ServiceBusSender) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSender) +* `ServiceBusReceiver` for receiving messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.html#azure.servicebus.ServiceBusReceiver) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusReceiver) +* `ServiceBusSessionReceiver` for receiving messages from a session. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.html#azure.servicebus.ServiceBusSessionReceiver) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSessionReceiver) As a user this will be largely transparent to you, as initialization will still occur primarily via the top level ServiceBusClient, the primary difference will be that rather than creating a queue_client, for instance, and then a sender off of that, you would simply From cfaa8df3a7035e6c77e0b2dbca1ca17aceb48175 Mon Sep 17 00:00:00 2001 From: Kieran Brantner-Magee Date: Mon, 5 Oct 2020 11:46:25 -0700 Subject: [PATCH 2/4] use 'latest' in blob doc paths instead of the actual version string to be future-proof, and fix a schedule->Send typo in migration guide. --- .../azure-servicebus/migration_guide.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/sdk/servicebus/azure-servicebus/migration_guide.md b/sdk/servicebus/azure-servicebus/migration_guide.md index bba5899c1fc6..e06bedda14ec 100644 --- a/sdk/servicebus/azure-servicebus/migration_guide.md +++ b/sdk/servicebus/azure-servicebus/migration_guide.md @@ -14,12 +14,12 @@ Note: The large version gap is in order to normalize service bus SDK versions ac ### Specific clients for sending and receiving In v7 we've simplified the API surface, making two distinct clients, rather than one for each of queue, topic, and subscription: -* `ServiceBusSender` for sending messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.html#azure.servicebus.ServiceBusSender) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSender) -* `ServiceBusReceiver` for receiving messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.html#azure.servicebus.ServiceBusReceiver) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusReceiver) -* `ServiceBusSessionReceiver` for receiving messages from a session. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.html#azure.servicebus.ServiceBusSessionReceiver) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b7/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSessionReceiver) +* `ServiceBusSender` for sending messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.html#azure.servicebus.ServiceBusSender) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSender) +* `ServiceBusReceiver` for receiving messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.html#azure.servicebus.ServiceBusReceiver) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusReceiver) +* `ServiceBusSessionReceiver` for receiving messages from a session. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.html#azure.servicebus.ServiceBusSessionReceiver) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/latest/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSessionReceiver) As a user this will be largely transparent to you, as initialization will still occur primarily via the top level ServiceBusClient, the primary difference will be that rather than creating a queue_client, for instance, and then a sender off of that, you would simply @@ -156,12 +156,12 @@ with queue_client.get_sender() as sender: # Send one at a time. for i in range(100): message = Message("Sample message no. {}".format(i)) - sender.schedule_messages(message) + sender.send(message) # Send as a batch. messages_to_batch = [Message("Batch message no. {}".format(i)) for i in range(10)] batch = BatchMessage(messages_to_batch) - sender.schedule_messages(batch) + sender.send(batch) ``` In v7: @@ -172,11 +172,11 @@ with ServiceBusClient.from_connection_string(conn_str=CONNECTION_STR) as client: # Sending one at a time. for i in range(100): message = Message("Sample message no. {}".format(i)) - sender.schedule_messages(message) + sender.send_messages(message) # Send as a batch batch = new BatchMessage() for i in range(10): batch.add(Message("Batch message no. {}".format(i))) - sender.schedule_messages(batch) + sender.send_messages(batch) ``` From 9bd6c6dd527d1327dd9720f70c3dd44df2c6bc9c Mon Sep 17 00:00:00 2001 From: Kieran Brantner-Magee Date: Mon, 5 Oct 2020 12:09:59 -0700 Subject: [PATCH 3/4] add pypi link to ignore-links so we don't need two cranks to release packages --- eng/ignore-links.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/eng/ignore-links.txt b/eng/ignore-links.txt index bd605f16d16a..3897e374d27a 100644 --- a/eng/ignore-links.txt +++ b/eng/ignore-links.txt @@ -1 +1,2 @@ -https://docs.microsoft.com/python/api/overview/azure/{{package_doc_id}} \ No newline at end of file +https://docs.microsoft.com/python/api/overview/azure/{{package_doc_id}} +https://pypi.org/project/azure-servicebus/{{package_version}}/ \ No newline at end of file From 65aa2fc0b009f862f9575e0a853329df08eae7fe Mon Sep 17 00:00:00 2001 From: Kieran Brantner-Magee Date: Mon, 5 Oct 2020 13:24:05 -0700 Subject: [PATCH 4/4] use absolute ignore link, wildcard not implemented yet. --- eng/ignore-links.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/ignore-links.txt b/eng/ignore-links.txt index 3897e374d27a..89d151167499 100644 --- a/eng/ignore-links.txt +++ b/eng/ignore-links.txt @@ -1,2 +1,2 @@ https://docs.microsoft.com/python/api/overview/azure/{{package_doc_id}} -https://pypi.org/project/azure-servicebus/{{package_version}}/ \ No newline at end of file +https://pypi.org/project/azure-servicebus/7.0.0b7/ \ No newline at end of file