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

docs: include packaging script steps in the maintainers guide #1672

Merged
merged 2 commits into from
Mar 13, 2025

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Mar 13, 2025

Summary

This PR copies the steps for using scripts/build_pypi_package.sh from slack_bolt - reference - to this maintainers_guide.md for fast reference 📚

Testing

The updated steps were used to test that the build script packages the .whl!

Category

  • /docs (Documents)
  • maintainers_guide.md

Requirements

  • 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 python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@zimeg zimeg added the docs M-T: Documentation work only label Mar 13, 2025
@zimeg zimeg requested a review from WilliamBergamin March 13, 2025 19:19
@zimeg zimeg self-assigned this Mar 13, 2025
Copy link

codecov bot commented Mar 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.36%. Comparing base (85f8f4b) to head (1426318).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1672   +/-   ##
=======================================
  Coverage   85.36%   85.36%           
=======================================
  Files         113      113           
  Lines       12802    12802           
=======================================
  Hits        10928    10928           
  Misses       1874     1874           

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

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

Good catch 💯 sometimes knowing things lets them slip through 😢

Left one small suggestion on something I learn today

@zimeg zimeg merged commit f1090b9 into main Mar 13, 2025
13 checks passed
@zimeg zimeg deleted the zimeg-docs-maintainers-guide-build branch March 13, 2025 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants