slack: add file upload functionality #9472

Powma · 2024-12-30T09:15:44Z

SUMMARY

Add file upload functionality to upload the files with the new API SLACK.

Continuation of #9431.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

Slack

ADDITIONAL INFORMATION

This enhancement allows you to upload files with the new version of the Slack API
https://api.slack.com/methods/files.completeUploadExternal
https://api.slack.com/methods/files.getUploadURLExternal

Example usage:

    - name: Upload a file to Slack
      community.general.slack:
        token: thetoken/generatedby/slack
        channel: 'kuma'
        upload_file:
          path: "/tmp/test.py"
          title: "main.py"
         snippet_type: "python"

ansibullbot · 2024-12-30T09:30:03Z

cc @ramondelafuente
click here for bot help

russoz

hi @Powma thanks for your contribution!

Other than fixing the sanity checks, and adding the version in the docs, it LGTM

plugins/modules/slack.py

felixfontein

Thanks for your contribution!

plugins/modules/slack.py

felixfontein · 2024-12-30T20:50:03Z

plugins/modules/slack.py

+        type: str
+        description:
+          - Optional title for the uploaded file.
+      thread_ts:


How does this option relate to the global thread_id?

- name: Send initial message to start a thread community.general.slack: token: "{{ slack_token }}" channel: "#channel" msg: "first" register: slack_response - name: Upload a file in the same thread community.general.slack: token: "{{ slack_token }}" channel: "#channel" upload_file: path: "/path/to/README.md" initial_comment: "blablabla" alt_text: "My README" thread_ts: "{{ slack_response.ts }}" # specific to file uploads

In this case, using thread_id globally has no effect on the file upload. It must be passed as thread_ts within the upload_file dictionary. That’s why this option is duplicated.

But - why? Can't you use the global parameter thread_id for the value of thread_ts?

felixfontein · 2024-12-30T20:51:23Z

plugins/modules/slack.py

+
+    if upload_file:
+        try:
+            upload_response = upload_file_to_slack(


Hmm, this seems to be very separate from the rest of the module. Maybe this should be a new module that only does file uploading, instead of squeezing this into the current module which is about posting messages?

Yeah, but should I create a new file in plugins/module_utils ?

Can we upload a file together with sending a message, as in the same request? If yes, then I would suggest to keep the feature in this module, else create a new module.

As of new file in module_utils, if you end up with two modules, it is likely there will be some common code between them and it would make total sense to put that common code in module_utils. If not, then probably no need to.

changelogs/fragments/slack.yml

russoz · 2025-02-23T21:55:28Z

ping @Powma

Are you still working on this?

felixfontein · 2025-03-23T13:53:16Z

needs_info

Powma · 2025-03-23T20:07:48Z

Sorry, I’ll take a look at it next week. I know there’s an IRC channel if I need help.

docs(slack): unify file upload API links Co-authored-by: Felix Fontein <[email protected]>

docs(slack): unify file upload API links Co-authored-by: Alexei Znamensky <[email protected]>

docs(changelog): improve wording for Slack upload feature Co-authored-by: Felix Fontein <[email protected]>

felixfontein · 2025-04-05T16:52:06Z

plugins/modules/slack.py

+        U(https://api.slack.com/methods/files.completeUploadExternal).
+    suboptions:
+      path:
+        type: str


Suggested change

type: str

type: path

felixfontein · 2025-04-05T16:52:38Z

plugins/modules/slack.py

+        type: str
+        description:
+          - Optional timestamp of parent message to thread this message, see U(https://api.slack.com/docs/message-threading).
+    version_added: 10.2.0


Suggested change

version_added: 10.2.0

version_added: 10.6.0

russoz · 2025-04-18T08:14:09Z

Hi @Powma

You are probably busy, but the PR is very close to being good to go, and we're having a release of the collection next week. Do you think you will have time to give it some TLC before that? No pressure, just trying to work on the logistics, there will be other releases in the future. :-)

feat(slack) : Add file upload functionality

d71a6e8

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-10 Automatically create a backport for the stable-10 branch labels Dec 30, 2024

This comment was marked as outdated.

Sign in to view

ansibullbot added feature This issue/PR relates to a feature request module module needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR new_contributor Help guide this first time contributor plugins plugin (any type) labels Dec 30, 2024

Powma force-pushed the module-slack branch from 588b00a to 4229fd2 Compare December 30, 2024 13:00

This comment was marked as outdated.

Sign in to view

Powma force-pushed the module-slack branch from 4229fd2 to ab21691 Compare December 30, 2024 17:59

This comment was marked as outdated.

Sign in to view

Powma force-pushed the module-slack branch from 58cd3bd to ab21691 Compare December 30, 2024 19:41

Changelog fragment

c0d8ffc

Powma force-pushed the module-slack branch from ab21691 to c0d8ffc Compare December 30, 2024 19:42

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Dec 30, 2024

russoz reviewed Dec 30, 2024

View reviewed changes

plugins/modules/slack.py Show resolved Hide resolved

felixfontein reviewed Dec 30, 2024

View reviewed changes

russoz changed the title ~~feat(slack) : Add file upload functionality~~ slack: add file upload functionality Jan 2, 2025

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Jan 10, 2025

ansibullbot added the needs_info This issue requires further information. Please answer any outstanding questions label Mar 23, 2025

ansibullbot removed the needs_info This issue requires further information. Please answer any outstanding questions label Mar 23, 2025

Powma and others added 2 commits March 27, 2025 10:57

Update plugins/modules/slack.py

37a2fd9

docs(slack): unify file upload API links Co-authored-by: Felix Fontein <[email protected]>

Update plugins/modules/slack.py

8941a2e

docs(slack): unify file upload API links Co-authored-by: Alexei Znamensky <[email protected]>

ansibullbot removed the stale_ci CI is older than 7 days, rerun before merging label Mar 27, 2025

ansibullbot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Mar 27, 2025

Update changelogs/fragments/slack.yml

ce23364

docs(changelog): improve wording for Slack upload feature Co-authored-by: Felix Fontein <[email protected]>

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Mar 27, 2025

This comment was marked as outdated.

Sign in to view

ansibullbot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Mar 27, 2025

Powma force-pushed the module-slack branch from 792148f to ce23364 Compare March 27, 2025 13:21

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Mar 27, 2025

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Mar 27, 2025

feat(slack) : Add file upload functionality

56e3065

Powma force-pushed the module-slack branch from 6e056b2 to 56e3065 Compare March 27, 2025 13:50

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Mar 27, 2025

felixfontein reviewed Apr 5, 2025

View reviewed changes

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Apr 5, 2025

slack: add file upload functionality #9472

Are you sure you want to change the base?

slack: add file upload functionality #9472

Uh oh!

Conversation

Powma commented Dec 30, 2024 • edited by felixfontein Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Uh oh!

This comment was marked as outdated.

ansibullbot commented Dec 30, 2024

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

russoz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

felixfontein left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

felixfontein Dec 30, 2024

Choose a reason for hiding this comment

Uh oh!

Powma Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

felixfontein Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

felixfontein Dec 30, 2024

Choose a reason for hiding this comment

Uh oh!

Powma Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

russoz Mar 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

russoz commented Feb 23, 2025

Uh oh!

felixfontein commented Mar 23, 2025

Uh oh!

Powma commented Mar 23, 2025

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

felixfontein Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

russoz commented Apr 18, 2025

Uh oh!

Uh oh!

Powma commented Dec 30, 2024 •

edited by felixfontein

Loading

Powma Mar 27, 2025 •

edited

Loading