Skip to content

Commit

Permalink
Add compatibility note
Browse files Browse the repository at this point in the history
  • Loading branch information
taiki-e committed Jul 31, 2022
1 parent dd3a3c5 commit 3552db0
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ GitHub Action for creating GitHub Releases based on changelog.
- [Example workflow: No changelog](#example-workflow-no-changelog)
- [Example workflow: Reject releases from outside of main branch](#example-workflow-reject-releases-from-outside-of-main-branch)
- [Other examples](#other-examples)
- [Compatibility](#compatibility)
- [Related Projects](#related-projects)
- [License](#license)

Expand Down Expand Up @@ -209,6 +210,16 @@ jobs:
- [taiki-e/cargo-hack](https://github.com/taiki-e/cargo-hack/blob/202e6e59d491c9202ce148c9ef423853267226db/.github/workflows/release.yml#L25-L45)
- [tokio-rs/tracing](https://github.com/tokio-rs/tracing/blob/2aa0cb010d8a7fa0de610413b5acd4557a00dd34/.github/workflows/release.yml#L10-L24)

## Compatibility

This action has been tested for action runners hosted by GitHub.
To use this action in self-hosted runners or in containers, you will need to install at least the following:

- bash, GNU Coreutils, GNU grep, GNU tar
- curl
- git
- gh (GitHub CLI)

## Related Projects

- [upload-rust-binary-action]: GitHub Action for building and uploading Rust binary to GitHub Releases.
Expand Down

0 comments on commit 3552db0

Please sign in to comment.