|
4 | 4 |
|
5 | 5 | [](https://codecov.io/gh/slackapi/slack-github-action) |
6 | 6 |
|
| 7 | +Table of contents: |
| 8 | + |
| 9 | +- [**Example workflows**](#example-workflows): Find inspiration in steps. |
| 10 | +- [**Sending variables**](#sending-variables): Provide inputs to be sent. |
| 11 | +- [**Sending techniques**](#sending-techniques): Choose how to send inputs. |
| 12 | +- [**Additional configurations**](#additional-configurations): Customize |
| 13 | + options. |
| 14 | +- [**Expected outputs**](#expected-outputs): Retrieve response values. |
| 15 | +- [**Project details**](#project-details): Information on the codebase. |
| 16 | + |
7 | 17 | ## Example workflows |
8 | 18 |
|
9 | 19 | For examples on how to leverage this Action in workflows, check out |
@@ -518,11 +528,24 @@ a Slack channel before posting a message: |
518 | 528 | text: "A PR was created <!date^${{ steps.conversation.outputs.time }}^{date_num} at {time_secs}|just now>: ${{ github.event.pull_request.html_url }}" |
519 | 529 | ``` |
520 | 530 |
|
521 | | -## License |
| 531 | +## Project details |
| 532 | + |
| 533 | +### Versioning |
| 534 | + |
| 535 | +We recommend using the latest version of this Action for the most recent updates |
| 536 | +and fixes. |
| 537 | + |
| 538 | +Migration guides are available in the [release notes][releases] with breaking |
| 539 | +changes noted between versions. |
| 540 | + |
| 541 | +Changes required when upgrading from `@v1` to `@v2` are included in this |
| 542 | +[migration guide][v2.0.0]. |
| 543 | + |
| 544 | +### License |
522 | 545 |
|
523 | 546 | This project is licensed under the [MIT license](LICENSE). |
524 | 547 |
|
525 | | -## Contributing |
| 548 | +### Contributing |
526 | 549 |
|
527 | 550 | All contributions are encouraged! Check out the |
528 | 551 | [contributor's guide][contributing] to learn more. |
@@ -560,13 +583,15 @@ All contributions are encouraged! Check out the |
560 | 583 | [mrkdwn]: https://api.slack.com/reference/surfaces/formatting |
561 | 584 | [plans]: https://slack.com/pricing |
562 | 585 | [rate-limits]: https://api.slack.com/apis/rate-limits |
| 586 | +[releases]: https://github.com/slackapi/slack-github-action/releases |
563 | 587 | [repo-secret]: https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository |
564 | 588 | [response]: https://api.slack.com/web#responses |
565 | 589 | [retries]: https://tools.slack.dev/node-slack-sdk/web-api/#automatic-retries |
566 | 590 | [retry-after]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After |
567 | 591 | [scopes]: https://api.slack.com/scopes |
568 | 592 | [slack-web-api]: https://tools.slack.dev/node-slack-sdk/web-api |
569 | 593 | [tokens]: https://api.slack.com/concepts/token-types |
| 594 | +[v2.0.0]: https://github.com/slackapi/slack-github-action/releases/tag/v2.0.0 |
570 | 595 | [variables]: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables |
571 | 596 | [wfb]: https://slack.com/features/workflow-automation |
572 | 597 | [wfb-create]: https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack |
0 commit comments