Skip to content

Commit a1646ab

Browse files
authored
docs: include versioning details and migration guides in the readme (#410)
1 parent f841ea5 commit a1646ab

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
55
[![codecov](https://codecov.io/gh/slackapi/slack-github-action/graph/badge.svg?token=OZNX7FHN78)](https://codecov.io/gh/slackapi/slack-github-action)
66

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+
717
## Example workflows
818

919
For examples on how to leverage this Action in workflows, check out
@@ -518,11 +528,24 @@ a Slack channel before posting a message:
518528
text: "A PR was created <!date^${{ steps.conversation.outputs.time }}^{date_num} at {time_secs}|just now>: ${{ github.event.pull_request.html_url }}"
519529
```
520530

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
522545

523546
This project is licensed under the [MIT license](LICENSE).
524547

525-
## Contributing
548+
### Contributing
526549

527550
All contributions are encouraged! Check out the
528551
[contributor's guide][contributing] to learn more.
@@ -560,13 +583,15 @@ All contributions are encouraged! Check out the
560583
[mrkdwn]: https://api.slack.com/reference/surfaces/formatting
561584
[plans]: https://slack.com/pricing
562585
[rate-limits]: https://api.slack.com/apis/rate-limits
586+
[releases]: https://github.com/slackapi/slack-github-action/releases
563587
[repo-secret]: https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository
564588
[response]: https://api.slack.com/web#responses
565589
[retries]: https://tools.slack.dev/node-slack-sdk/web-api/#automatic-retries
566590
[retry-after]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
567591
[scopes]: https://api.slack.com/scopes
568592
[slack-web-api]: https://tools.slack.dev/node-slack-sdk/web-api
569593
[tokens]: https://api.slack.com/concepts/token-types
594+
[v2.0.0]: https://github.com/slackapi/slack-github-action/releases/tag/v2.0.0
570595
[variables]: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables
571596
[wfb]: https://slack.com/features/workflow-automation
572597
[wfb-create]: https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack

0 commit comments

Comments
 (0)