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

feat: Add deprecation warnings to Steps from Apps components and Docs #1089

Merged

Conversation

WilliamBergamin
Copy link
Contributor

This PR aims to inform developers that steps from apps are deprecated

  • Add a deprecation notice in the docstring of steps from apps components
  • Adds a runtime deprecation warning displayed whenever the step handler is invoked
  • Adds deprecation notice in the examples
  • Adds a deprecation notice to the slack.dev
Before After
Screenshot 2024-06-06 at 12 51 36 PM Screenshot 2024-06-06 at 12 51 04 PM

Category

  • slack_bolt.App and/or its core components
  • slack_bolt.async_app.AsyncApp and/or its core components
  • Adapters in slack_bolt.adapter
  • Document pages under /docs
  • Others

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run ./scripts/install_all_and_run_tests.sh after making the changes.

@WilliamBergamin WilliamBergamin added docs Improvements or additions to documentation area:async area:sync area:examples issues related to example or sample code labels Jun 6, 2024
@WilliamBergamin WilliamBergamin requested review from seratch and filmaj June 6, 2024 17:07
@WilliamBergamin WilliamBergamin self-assigned this Jun 6, 2024
docs/_config.yml Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jun 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.77%. Comparing base (549252c) to head (3c90f1a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1089   +/-   ##
=======================================
  Coverage   91.76%   91.77%           
=======================================
  Files         186      186           
  Lines        6403     6407    +4     
=======================================
+ Hits         5876     5880    +4     
  Misses        527      527           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

Thanks for working on this! Once the Japanese label is fixed, you can go ahead with these changes!

docs/_config.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@filmaj filmaj left a comment

Choose a reason for hiding this comment

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

Left a minor URL typo

docs/_steps/workflow_steps_overview.md Outdated Show resolved Hide resolved
Co-authored-by: Fil Maj <maj.fil@gmail.com>
@WilliamBergamin WilliamBergamin merged commit 2882708 into slackapi:main Jun 7, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:async area:examples issues related to example or sample code area:sync docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants