ci: confirm expected autogenerated reference exists
Summary
This PR adds a check that confirms the expected autogenerated reference exists for a commit to confirm build previews compile and to reduce the overhead of a release 📚
For https://github.com/slackapi/slack-health-score/issues/116 and investigation toward https://github.com/slackapi/python-slack-sdk/issues/1752!
Testing
Category
- [x]
/docs(Documents) - [x]
tests/integration_tests(Automated tests for this library)
Requirements
- [x] I've read and understood the Contributing Guidelines and have done my best effort to follow them.
- [x] I've read and agree to the Code of Conduct.
- [x] I've run
python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.
Codecov Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 84.95%. Comparing base (83661b7) to head (b49b5b0).
:white_check_mark: All tests successful. No failed tests found.
Additional details and impacted files
@@ Coverage Diff @@
## main #1759 +/- ##
=======================================
Coverage 84.95% 84.95%
=======================================
Files 113 113
Lines 12905 12905
=======================================
Hits 10964 10964
Misses 1941 1941
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
@mwbrooks I share your excitement! 📚 ✨
An above check shows that the current changes of main don't match the expected reference, which I think we're hoping to find?
diff --git a/docs/reference/index.html b/docs/reference/index.html
index 8b9b9e3..9b6a27e 100644
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@@ -1856,7 +1856,7 @@ and message responses using response_url in payloads.</p></div>
def admin_users_list(
self,
*,
- team_id: str,
+ team_id: Optional[str] = None,
I'll add these changes to this PR for continued testing and polish 📠