You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "Polber (via GitHub)" <gi...@apache.org> on 2024/11/21 18:40:20 UTC

[PR] [yaml] remove PubSubLite from API docs [beam]

Polber opened a new pull request, #33184:
URL: https://github.com/apache/beam/pull/33184

   PubSubLite is deprecated as per https://cloud.google.com/pubsub/lite/docs, scheduled to be turned down March 18, 2026, and is no longer available for new customers as of September 24, 2024.
   
   In order to avoid confusion for new Beam YAML users, this transform will be hidden from the API docs, but still usable within the YAML API
   
   ------------------------
   
   Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
   
    - [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
    - [ ] Update `CHANGES.md` with noteworthy changes.
    - [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
   
   To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
   
   GitHub Actions Tests Status (on master branch)
   ------------------------------------------------------------------------------------------------
   [![Build python source distribution and wheels](https://github.com/apache/beam/workflows/Build%20python%20source%20distribution%20and%20wheels/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
   [![Python tests](https://github.com/apache/beam/workflows/Python%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Java tests](https://github.com/apache/beam/workflows/Java%20Tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Go tests](https://github.com/apache/beam/workflows/Go%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
   
   See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "Polber (via GitHub)" <gi...@apache.org>.
Polber commented on PR #33184:
URL: https://github.com/apache/beam/pull/33184#issuecomment-2491996675

   R: @robertwb 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "Polber (via GitHub)" <gi...@apache.org>.
Polber commented on code in PR #33184:
URL: https://github.com/apache/beam/pull/33184#discussion_r1868543002


##########
sdks/python/apache_beam/yaml/generate_yaml_docs.py:
##########
@@ -189,11 +189,11 @@ def io_grouping_key(transform_name):
     return 0, transform_name
 
 
-SKIP = [
-    'Combine',
-    'Filter',
-    'MapToFields',
-]
+# Deprecated providers
+SKIP = {
+    'ReadFromPubSubLite',
+    'WriteToPubSubLite',
+}

Review Comment:
   updated



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "Polber (via GitHub)" <gi...@apache.org>.
Polber commented on PR #33184:
URL: https://github.com/apache/beam/pull/33184#issuecomment-2491997061

   R: @damccorm 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #33184:
URL: https://github.com/apache/beam/pull/33184#issuecomment-2491999256

   Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment `assign set of reviewers`


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "robertwb (via GitHub)" <gi...@apache.org>.
robertwb commented on code in PR #33184:
URL: https://github.com/apache/beam/pull/33184#discussion_r1868507191


##########
sdks/python/apache_beam/yaml/generate_yaml_docs.py:
##########
@@ -189,11 +189,11 @@ def io_grouping_key(transform_name):
     return 0, transform_name
 
 
-SKIP = [
-    'Combine',
-    'Filter',
-    'MapToFields',
-]
+# Deprecated providers
+SKIP = {
+    'ReadFromPubSubLite',
+    'WriteToPubSubLite',
+}

Review Comment:
   That makes a lot of sense actually. 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "damccorm (via GitHub)" <gi...@apache.org>.
damccorm commented on code in PR #33184:
URL: https://github.com/apache/beam/pull/33184#discussion_r1854014949


##########
sdks/python/apache_beam/yaml/generate_yaml_docs.py:
##########
@@ -189,11 +189,11 @@ def io_grouping_key(transform_name):
     return 0, transform_name
 
 
-SKIP = [
-    'Combine',
-    'Filter',
-    'MapToFields',
-]
+# Deprecated providers
+SKIP = {
+    'ReadFromPubSubLite',
+    'WriteToPubSubLite',
+}

Review Comment:
   Instead of hiding these, can we just call out in the doc string that they're deprecated? Export from pubsublite is still a valid use case for a good chunk of users who are still using this



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "Polber (via GitHub)" <gi...@apache.org>.
Polber commented on PR #33184:
URL: https://github.com/apache/beam/pull/33184#issuecomment-2515981234

   Test failures seem unrelated


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #33184:
URL: https://github.com/apache/beam/pull/33184#issuecomment-2492063292

   ## [Codecov](https://app.codecov.io/gh/apache/beam/pull/33184?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
   Attention: Patch coverage is `0%` with `1 line` in your changes missing coverage. Please review.
   > Project coverage is 58.93%. Comparing base [(`a06454a`)](https://app.codecov.io/gh/apache/beam/commit/a06454a22084242b4fe089b570fd090810885885?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) to head [(`f5102b4`)](https://app.codecov.io/gh/apache/beam/commit/f5102b476fc5f42673e5052d60672a72764689e1?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
   
   | [Files with missing lines](https://app.codecov.io/gh/apache/beam/pull/33184?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Patch % | Lines |
   |---|---|---|
   | [sdks/python/apache\_beam/yaml/generate\_yaml\_docs.py](https://app.codecov.io/gh/apache/beam/pull/33184?src=pr&el=tree&filepath=sdks%2Fpython%2Fapache_beam%2Fyaml%2Fgenerate_yaml_docs.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c2Rrcy9weXRob24vYXBhY2hlX2JlYW0veWFtbC9nZW5lcmF0ZV95YW1sX2RvY3MucHk=) | 0.00% | [1 Missing :warning: ](https://app.codecov.io/gh/apache/beam/pull/33184?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) |
   
   <details><summary>Additional details and impacted files</summary>
   
   
   ```diff
   @@             Coverage Diff              @@
   ##             master   #33184      +/-   ##
   ============================================
   - Coverage     58.93%   58.93%   -0.01%     
     Complexity     3112     3112              
   ============================================
     Files          1133     1133              
     Lines        174989   174989              
     Branches       3343     3343              
   ============================================
   - Hits         103133   103130       -3     
   - Misses        68511    68514       +3     
     Partials       3345     3345              
   ```
   
   | [Flag](https://app.codecov.io/gh/apache/beam/pull/33184/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
   |---|---|---|
   | [python](https://app.codecov.io/gh/apache/beam/pull/33184/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `81.40% <0.00%> (-0.01%)` | :arrow_down: |
   
   Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
   
   </details>
   
   [:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/beam/pull/33184?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).   
   :loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
   
   ----
   🚨 Try these New Features:
   
   - [Flaky Tests Detection](https://docs.codecov.com/docs/test-result-ingestion-beta) - Detect and resolve failed and flaky tests
   - [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis) - Avoid shipping oversized bundles


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [yaml] remove PubSubLite from API docs [beam]

Posted by "damccorm (via GitHub)" <gi...@apache.org>.
damccorm merged PR #33184:
URL: https://github.com/apache/beam/pull/33184


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org