Skip to content

Commit ccd9426

Browse files
committed
chore: merge w main
2 parents b0b1686 + c04e899 commit ccd9426

File tree

24 files changed

+2723
-73
lines changed

24 files changed

+2723
-73
lines changed

.github/CODEOWNERS

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Salesforce Open Source project configuration
2+
# Learn more: https://github.com/salesforce/oss-template
3+
#ECCN:Open Source
4+
#GUSINFO:Open Source,Open Source Workflow
5+
6+
# @slackapi/slack-platform-python
7+
# are code reviewers for all changes in this repo.
8+
* @slackapi/slack-platform-python
9+
10+
# @slackapi/developer-education
11+
# are code reviewers for changes in the `/docs` directory.
12+
/docs/ @slackapi/developer-education

.github/maintainers_guide.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -175,15 +175,17 @@ Before creating a new release, ensure that everything on a stable branch has
175175
landed, then [run the tests](#unit-tests).
176176

177177
1. Create the commit for the release
178-
1. In `slack_sdk/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and [Developmental Release](https://peps.python.org/pep-0440/#developmental-releases).
178+
1. Use the latest supported Python version. Using a [virtual environment](#python-and-friends) is recommended.
179+
2. In `slack_sdk/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and [Developmental Release](https://peps.python.org/pep-0440/#developmental-releases).
179180
- Example: if the current version is `1.2.3`, a proper development bump would be `1.2.4.dev0`
180181
- `.dev` will indicate to pip that this is a [Development Release](https://peps.python.org/pep-0440/#developmental-releases)
181182
- Note that the `dev` version can be bumped in development releases: `1.2.4.dev0` -> `1.2.4.dev1`
182-
2. Build the docs with `./scripts/generate_api_docs.sh`.
183-
3. Commit with a message including the new version number. For example `1.2.4.dev0` & push the commit to a branch where the development release will live (create it if it does not exist)
183+
3. Build the docs with `./scripts/generate_api_docs.sh`.
184+
4. Commit with a message including the new version number. For example `1.2.4.dev0` & push the commit to a branch where the development release will live (create it if it does not exist)
184185
1. `git checkout -b future-release`
185-
2. `git commit -m 'chore(release): version 1.2.4.dev0'`
186-
3. `git push -u origin future-release`
186+
2. `git add --all` (review files with `git status` before committing)
187+
3. `git commit -m 'chore(release): version 1.2.4.dev0'`
188+
4. `git push -u origin future-release`
187189
2. Create a new GitHub Release
188190
1. Navigate to the [Releases page](https://github.com/slackapi/python-slack-sdk/releases).
189191
2. Click the "Draft a new release" button.
@@ -207,14 +209,16 @@ Before creating a new release, ensure that everything on the `main` branch since
207209
the last tag is in a releasable state! At a minimum, [run the tests](#unit-tests).
208210
209211
1. Create the commit for the release
210-
1. In `slack_sdk/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and the [Versioning](#versioning-and-tags) section.
211-
2. Build the docs with `./scripts/generate_api_docs.sh`.
212-
3. Commit with a message including the new version number. For example `1.2.3` & push the commit to a branch and create a PR to sanity check.
212+
1. Use the latest supported Python version. Using a [virtual environment](#python-and-friends) is recommended.
213+
2. In `slack_sdk/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and the [Versioning](#versioning-and-tags) section.
214+
3. Build the docs with `./scripts/generate_api_docs.sh`.
215+
4. Commit with a message including the new version number. For example `1.2.3` & push the commit to a branch and create a PR to sanity check.
213216
1. `git checkout -b 1.2.3-release`
214-
2. `git commit -m 'chore(release): version 1.2.3'`
215-
3. `git push -u origin 1.2.3-release`
216-
4. Add relevant labels to the PR and add the PR to a GitHub Milestone.
217-
5. Merge in release PR after getting an approval from at least one maintainer.
217+
2. `git add --all` (review files with `git status` before committing)
218+
3. `git commit -m 'chore(release): version 1.2.3'`
219+
4. `git push -u origin 1.2.3-release`
220+
5. Add relevant labels to the PR and add the PR to a GitHub Milestone.
221+
6. Merge in release PR after getting an approval from at least one maintainer.
218222
2. Create a new GitHub Release
219223
1. Navigate to the [Releases page](https://github.com/slackapi/python-slack-sdk/releases).
220224
2. Click the "Draft a new release" button.

.github/workflows/tests.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,19 +80,24 @@ jobs:
8080
PYTHONPATH=$PWD:$PYTHONPATH pytest tests/slack_sdk/oauth/state_store/test_sqlalchemy.py
8181
- name: Upload test results to Codecov
8282
if: ${{ !cancelled() }}
83-
uses: codecov/test-results-action@47f89e9acb64b76debcd5ea40642d25a4adced9f # v1.1.1
83+
uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
8484
with:
8585
directory: ./reports/
86+
fail_ci_if_error: true
8687
flags: ${{ matrix.python-version }}
88+
report_type: test_results
8789
token: ${{ secrets.CODECOV_TOKEN }}
8890
verbose: true
8991
- name: Upload test coverage to Codecov (only with latest supported version)
9092
if: startsWith(matrix.python-version, '3.14')
9193
uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
9294
with:
93-
token: ${{ secrets.CODECOV_TOKEN }}
95+
fail_ci_if_error: true
9496
# Run validation generates the coverage file
9597
files: ./coverage.xml
98+
report_type: coverage
99+
token: ${{ secrets.CODECOV_TOKEN }}
100+
verbose: true
96101
notifications:
97102
name: Regression notifications
98103
runs-on: ubuntu-latest

docs/reference/models/blocks/basic_components.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,7 @@ <h3>Inherited members</h3>
378378
):
379379
&#34;&#34;&#34;
380380
A feedback button element object for either positive or negative feedback.
381+
https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element#button-object-fields
381382

382383
Args:
383384
text (required): An object containing some text. Maximum length for this field is 75 characters.
@@ -410,7 +411,8 @@ <h3>Inherited members</h3>
410411
return json</code></pre>
411412
</details>
412413
<div class="desc"><p>The base class for JSON serializable class objects</p>
413-
<p>A feedback button element object for either positive or negative feedback.</p>
414+
<p>A feedback button element object for either positive or negative feedback.
415+
<a href="https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element#button-object-fields">https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element#button-object-fields</a></p>
414416
<h2 id="args">Args</h2>
415417
<dl>
416418
<dt><strong><code>text</code></strong> :&ensp;<code>required</code></dt>

docs/reference/models/blocks/block_elements.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1868,6 +1868,7 @@ <h3>Inherited members</h3>
18681868
**others: dict,
18691869
):
18701870
&#34;&#34;&#34;Buttons to indicate positive or negative feedback.
1871+
https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element
18711872

18721873
Args:
18731874
action_id (required): An identifier for this action.
@@ -1885,7 +1886,8 @@ <h3>Inherited members</h3>
18851886
</details>
18861887
<div class="desc"><p>Block Elements are things that exists inside of your Blocks.
18871888
<a href="https://docs.slack.dev/reference/block-kit/block-elements/">https://docs.slack.dev/reference/block-kit/block-elements/</a></p>
1888-
<p>Buttons to indicate positive or negative feedback.</p>
1889+
<p>Buttons to indicate positive or negative feedback.
1890+
<a href="https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element">https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element</a></p>
18891891
<h2 id="args">Args</h2>
18901892
<dl>
18911893
<dt><strong><code>action_id</code></strong> :&ensp;<code>required</code></dt>
@@ -2074,6 +2076,7 @@ <h3>Inherited members</h3>
20742076
**others: dict,
20752077
):
20762078
&#34;&#34;&#34;An icon button to perform actions.
2079+
https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element
20772080

20782081
Args:
20792082
action_id: An identifier for this action.
@@ -2103,7 +2106,8 @@ <h3>Inherited members</h3>
21032106
</details>
21042107
<div class="desc"><p>Block Elements are things that exists inside of your Blocks.
21052108
<a href="https://docs.slack.dev/reference/block-kit/block-elements/">https://docs.slack.dev/reference/block-kit/block-elements/</a></p>
2106-
<p>An icon button to perform actions.</p>
2109+
<p>An icon button to perform actions.
2110+
<a href="https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element">https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element</a></p>
21072111
<h2 id="args">Args</h2>
21082112
<dl>
21092113
<dt><strong><code>action_id</code></strong></dt>
@@ -3225,18 +3229,21 @@ <h3>Inherited members</h3>
32253229
italic: Optional[bool] = None,
32263230
strike: Optional[bool] = None,
32273231
code: Optional[bool] = None,
3232+
underline: Optional[bool] = None,
32283233
):
32293234
self.bold = bold
32303235
self.italic = italic
32313236
self.strike = strike
32323237
self.code = code
3238+
self.underline = underline
32333239

32343240
def to_dict(self, *args) -&gt; dict:
32353241
result = {
32363242
&#34;bold&#34;: self.bold,
32373243
&#34;italic&#34;: self.italic,
32383244
&#34;strike&#34;: self.strike,
32393245
&#34;code&#34;: self.code,
3246+
&#34;underline&#34;: self.underline,
32403247
}
32413248
return {k: v for k, v in result.items() if v is not None}
32423249

docs/reference/models/blocks/blocks.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,7 @@ <h3>Inherited members</h3>
433433
**others: dict,
434434
):
435435
&#34;&#34;&#34;Displays actions as contextual info, which can include both feedback buttons and icon buttons.
436+
https://docs.slack.dev/reference/block-kit/blocks/context-actions-block
436437

437438
Args:
438439
elements (required): An array of feedback_buttons or icon_button block elements. Maximum number of items is 5.
@@ -457,7 +458,8 @@ <h3>Inherited members</h3>
457458
<div class="desc"><p>Blocks are a series of components that can be combined
458459
to create visually rich and compellingly interactive messages.
459460
<a href="https://docs.slack.dev/reference/block-kit/blocks">https://docs.slack.dev/reference/block-kit/blocks</a></p>
460-
<p>Displays actions as contextual info, which can include both feedback buttons and icon buttons.</p>
461+
<p>Displays actions as contextual info, which can include both feedback buttons and icon buttons.
462+
<a href="https://docs.slack.dev/reference/block-kit/blocks/context-actions-block">https://docs.slack.dev/reference/block-kit/blocks/context-actions-block</a></p>
461463
<h2 id="args">Args</h2>
462464
<dl>
463465
<dt><strong><code>elements</code></strong> :&ensp;<code>required</code></dt>

docs/reference/models/blocks/index.html

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1369,6 +1369,7 @@ <h3>Inherited members</h3>
13691369
**others: dict,
13701370
):
13711371
&#34;&#34;&#34;Displays actions as contextual info, which can include both feedback buttons and icon buttons.
1372+
https://docs.slack.dev/reference/block-kit/blocks/context-actions-block
13721373

13731374
Args:
13741375
elements (required): An array of feedback_buttons or icon_button block elements. Maximum number of items is 5.
@@ -1393,7 +1394,8 @@ <h3>Inherited members</h3>
13931394
<div class="desc"><p>Blocks are a series of components that can be combined
13941395
to create visually rich and compellingly interactive messages.
13951396
<a href="https://docs.slack.dev/reference/block-kit/blocks">https://docs.slack.dev/reference/block-kit/blocks</a></p>
1396-
<p>Displays actions as contextual info, which can include both feedback buttons and icon buttons.</p>
1397+
<p>Displays actions as contextual info, which can include both feedback buttons and icon buttons.
1398+
<a href="https://docs.slack.dev/reference/block-kit/blocks/context-actions-block">https://docs.slack.dev/reference/block-kit/blocks/context-actions-block</a></p>
13971399
<h2 id="args">Args</h2>
13981400
<dl>
13991401
<dt><strong><code>elements</code></strong> :&ensp;<code>required</code></dt>
@@ -2762,6 +2764,7 @@ <h3>Inherited members</h3>
27622764
):
27632765
&#34;&#34;&#34;
27642766
A feedback button element object for either positive or negative feedback.
2767+
https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element#button-object-fields
27652768

27662769
Args:
27672770
text (required): An object containing some text. Maximum length for this field is 75 characters.
@@ -2794,7 +2797,8 @@ <h3>Inherited members</h3>
27942797
return json</code></pre>
27952798
</details>
27962799
<div class="desc"><p>The base class for JSON serializable class objects</p>
2797-
<p>A feedback button element object for either positive or negative feedback.</p>
2800+
<p>A feedback button element object for either positive or negative feedback.
2801+
<a href="https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element#button-object-fields">https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element#button-object-fields</a></p>
27982802
<h2 id="args">Args</h2>
27992803
<dl>
28002804
<dt><strong><code>text</code></strong> :&ensp;<code>required</code></dt>
@@ -2901,6 +2905,7 @@ <h3>Inherited members</h3>
29012905
**others: dict,
29022906
):
29032907
&#34;&#34;&#34;Buttons to indicate positive or negative feedback.
2908+
https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element
29042909

29052910
Args:
29062911
action_id (required): An identifier for this action.
@@ -2918,7 +2923,8 @@ <h3>Inherited members</h3>
29182923
</details>
29192924
<div class="desc"><p>Block Elements are things that exists inside of your Blocks.
29202925
<a href="https://docs.slack.dev/reference/block-kit/block-elements/">https://docs.slack.dev/reference/block-kit/block-elements/</a></p>
2921-
<p>Buttons to indicate positive or negative feedback.</p>
2926+
<p>Buttons to indicate positive or negative feedback.
2927+
<a href="https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element">https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element</a></p>
29222928
<h2 id="args">Args</h2>
29232929
<dl>
29242930
<dt><strong><code>action_id</code></strong> :&ensp;<code>required</code></dt>
@@ -3196,6 +3202,7 @@ <h3>Inherited members</h3>
31963202
**others: dict,
31973203
):
31983204
&#34;&#34;&#34;An icon button to perform actions.
3205+
https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element
31993206

32003207
Args:
32013208
action_id: An identifier for this action.
@@ -3225,7 +3232,8 @@ <h3>Inherited members</h3>
32253232
</details>
32263233
<div class="desc"><p>Block Elements are things that exists inside of your Blocks.
32273234
<a href="https://docs.slack.dev/reference/block-kit/block-elements/">https://docs.slack.dev/reference/block-kit/block-elements/</a></p>
3228-
<p>An icon button to perform actions.</p>
3235+
<p>An icon button to perform actions.
3236+
<a href="https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element">https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element</a></p>
32293237
<h2 id="args">Args</h2>
32303238
<dl>
32313239
<dt><strong><code>action_id</code></strong></dt>
@@ -5617,18 +5625,21 @@ <h3>Inherited members</h3>
56175625
italic: Optional[bool] = None,
56185626
strike: Optional[bool] = None,
56195627
code: Optional[bool] = None,
5628+
underline: Optional[bool] = None,
56205629
):
56215630
self.bold = bold
56225631
self.italic = italic
56235632
self.strike = strike
56245633
self.code = code
5634+
self.underline = underline
56255635

56265636
def to_dict(self, *args) -&gt; dict:
56275637
result = {
56285638
&#34;bold&#34;: self.bold,
56295639
&#34;italic&#34;: self.italic,
56305640
&#34;strike&#34;: self.strike,
56315641
&#34;code&#34;: self.code,
5642+
&#34;underline&#34;: self.underline,
56325643
}
56335644
return {k: v for k, v in result.items() if v is not None}
56345645

docs/reference/scim/async_client.html

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
163163
await self.api_call(
164164
http_verb=&#34;PATCH&#34;,
165165
path=f&#34;Users/{quote(id)}&#34;,
166-
body_params=partial_user.to_dict()
167-
if isinstance(partial_user, User)
168-
else _to_dict_without_not_given(partial_user),
166+
body_params=(
167+
partial_user.to_dict() if isinstance(partial_user, User) else _to_dict_without_not_given(partial_user)
168+
),
169169
)
170170
)
171171

@@ -228,9 +228,11 @@ <h2 class="section-title" id="header-classes">Classes</h2>
228228
await self.api_call(
229229
http_verb=&#34;PATCH&#34;,
230230
path=f&#34;Groups/{quote(id)}&#34;,
231-
body_params=partial_group.to_dict()
232-
if isinstance(partial_group, Group)
233-
else _to_dict_without_not_given(partial_group),
231+
body_params=(
232+
partial_group.to_dict()
233+
if isinstance(partial_group, Group)
234+
else _to_dict_without_not_given(partial_group)
235+
),
234236
)
235237
)
236238

@@ -620,9 +622,11 @@ <h3>Methods</h3>
620622
await self.api_call(
621623
http_verb=&#34;PATCH&#34;,
622624
path=f&#34;Groups/{quote(id)}&#34;,
623-
body_params=partial_group.to_dict()
624-
if isinstance(partial_group, Group)
625-
else _to_dict_without_not_given(partial_group),
625+
body_params=(
626+
partial_group.to_dict()
627+
if isinstance(partial_group, Group)
628+
else _to_dict_without_not_given(partial_group)
629+
),
626630
)
627631
)</code></pre>
628632
</details>
@@ -641,9 +645,9 @@ <h3>Methods</h3>
641645
await self.api_call(
642646
http_verb=&#34;PATCH&#34;,
643647
path=f&#34;Users/{quote(id)}&#34;,
644-
body_params=partial_user.to_dict()
645-
if isinstance(partial_user, User)
646-
else _to_dict_without_not_given(partial_user),
648+
body_params=(
649+
partial_user.to_dict() if isinstance(partial_user, User) else _to_dict_without_not_given(partial_user)
650+
),
647651
)
648652
)</code></pre>
649653
</details>

docs/reference/scim/v1/async_client.html

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
163163
await self.api_call(
164164
http_verb=&#34;PATCH&#34;,
165165
path=f&#34;Users/{quote(id)}&#34;,
166-
body_params=partial_user.to_dict()
167-
if isinstance(partial_user, User)
168-
else _to_dict_without_not_given(partial_user),
166+
body_params=(
167+
partial_user.to_dict() if isinstance(partial_user, User) else _to_dict_without_not_given(partial_user)
168+
),
169169
)
170170
)
171171

@@ -228,9 +228,11 @@ <h2 class="section-title" id="header-classes">Classes</h2>
228228
await self.api_call(
229229
http_verb=&#34;PATCH&#34;,
230230
path=f&#34;Groups/{quote(id)}&#34;,
231-
body_params=partial_group.to_dict()
232-
if isinstance(partial_group, Group)
233-
else _to_dict_without_not_given(partial_group),
231+
body_params=(
232+
partial_group.to_dict()
233+
if isinstance(partial_group, Group)
234+
else _to_dict_without_not_given(partial_group)
235+
),
234236
)
235237
)
236238

@@ -620,9 +622,11 @@ <h3>Methods</h3>
620622
await self.api_call(
621623
http_verb=&#34;PATCH&#34;,
622624
path=f&#34;Groups/{quote(id)}&#34;,
623-
body_params=partial_group.to_dict()
624-
if isinstance(partial_group, Group)
625-
else _to_dict_without_not_given(partial_group),
625+
body_params=(
626+
partial_group.to_dict()
627+
if isinstance(partial_group, Group)
628+
else _to_dict_without_not_given(partial_group)
629+
),
626630
)
627631
)</code></pre>
628632
</details>
@@ -641,9 +645,9 @@ <h3>Methods</h3>
641645
await self.api_call(
642646
http_verb=&#34;PATCH&#34;,
643647
path=f&#34;Users/{quote(id)}&#34;,
644-
body_params=partial_user.to_dict()
645-
if isinstance(partial_user, User)
646-
else _to_dict_without_not_given(partial_user),
648+
body_params=(
649+
partial_user.to_dict() if isinstance(partial_user, User) else _to_dict_without_not_given(partial_user)
650+
),
647651
)
648652
)</code></pre>
649653
</details>

0 commit comments

Comments
 (0)