Skip to content

Commit d07fadf

Browse files
docs: pulls out variables into separate page (#425)
1 parent d947f9a commit d07fadf

2 files changed

Lines changed: 12 additions & 13 deletions

File tree

docs/sending-variables.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Sending variables
2+
3+
There are different [techniques to send data](/slack-github-action/sending-techniques) into Slack and whichever one is chosen will require a certain set of customized inputs, as described later.
4+
5+
You can provide data to send to Slack from this GitHub Action and either source:
6+
7+
- The default event [context](https://github.com/actions/toolkit/blob/main/packages/github/src/context.ts#L6) with a [payload](https://docs.github.com/en/webhooks/webhook-events-and-payloads) matching the GitHub event.
8+
- A custom payload with optional [variables](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables) provided in the GitHub Action step.
9+
10+
These input options are valid for all techniques, but some techniques require specific constraints with certain requirements for valid inputs.
11+
12+
Additional [configurations](/slack-github-action/additional-configurations) and other details are also available for more customizations to the provided payload.

docs/slack-github-action.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,6 @@
22

33
The GitHub Action for sending data to Slack.
44

5-
## Sending variables
6-
7-
There are different [techniques to send data](/slack-github-action/sending-techniques) into Slack and whichever one is chosen will require a certain set of customized inputs, as described later.
8-
9-
You can provide data to send to Slack from this GitHub Action and either source:
10-
11-
- The default event [context](https://github.com/actions/toolkit/blob/main/packages/github/src/context.ts#L6) with a [payload](https://docs.github.com/en/webhooks/webhook-events-and-payloads) matching the GitHub event.
12-
- A custom payload with optional [variables](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables) provided in the GitHub Action step.
13-
14-
These input options are valid for all techniques, but some techniques require specific constraints with certain requirements for valid inputs.
15-
16-
Additional [configurations](/slack-github-action/additional-configurations) and other details are also available for more customizations to the provided payload.
17-
185
## Versioning
196

207
We recommend using the latest version of this GitHub Action for the most recent updates and fixes.

0 commit comments

Comments
 (0)