Skip to content

docs: note requirement of checkout to upload existing files #607

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.

Sign up for GitHub

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

Open
zimeg wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −1
Open

docs: note requirement of checkout to upload existing files #607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/sending-data-slack-api-method.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ Posting [threaded replies to a message](/messaging/#threading) from a past job c
Calling [a Slack API method](/reference/methods) with [`@slack/web-api`](/tools/node-slack-sdk/web-api/) makes [uploading a file](/messaging/working-with-files#uploading_files) just another API call with all of the convenience of the [`files.uploadV2`](/tools/node-slack-sdk/web-api/#upload-a-file) method:

```yaml
- name: Checkout an imagined project
uses: actions/checkout@v6
- name: Share a file to that channel
uses: slackapi/slack-github-action@v3.0.3
with:
Expand All @@ -135,6 +137,8 @@ Calling [a Slack API method](/reference/methods) with [`@slack/web-api`](/tools/
filename: "results-${{ github.sha }}.out"
```

The [checkout](https://github.com/actions/checkout) step makes existing contents available to upload from a workflow.

## Expected outputs

The technique, like all Slack Github Action techniques, [outputs values](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/passing-information-between-jobs) that can be used as inputs in following steps of a GitHub workflow.
Expand Down Expand Up @@ -173,7 +177,6 @@ https://github.com/slackapi/slack-github-action/blob/main/example-workflows/Tech

This workflow creates a channel after a bug is reported and add members of a usergroup by chaining multiple Slack API method calls together.


```js reference
https://github.com/slackapi/slack-github-action/blob/main/example-workflows/Technique_2_Slack_API_Method/invite.yml
```
Expand Down
Loading