Skip to content

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

Merged
zimeg merged 2 commits into
mainfrom
zimeg-docs-maintainers-guide-build
Mar 13, 2025
Merged

docs: include packaging script steps in the maintainers guide#1672
zimeg merged 2 commits into
mainfrom
zimeg-docs-maintainers-guide-build

Conversation

@zimeg

Copy link
Copy Markdown
Member

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.

@zimegzimeg added the docs M-T: Documentation work only label Mar 13, 2025
@zimegzimeg self-assigned this Mar 13, 2025
@codecov

codecovBot commented Mar 13, 2025

Copy link
Copy Markdown

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.

@WilliamBergaminWilliamBergamin left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread.github/maintainers_guide.md Outdated
Co-authored-by: William Bergamin <wbergamin@salesforce.com>
@zimeg
zimeg merged commit f1090b9 into mainMar 13, 2025
@zimeg
zimeg deleted the zimeg-docs-maintainers-guide-build branch March 13, 2025 22:39
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsM-T: Documentation work only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@zimeg@WilliamBergamin