From 3552db0a4300d9b831ea9162b59f174a068a4e47 Mon Sep 17 00:00:00 2001 From: Taiki Endo Date: Sun, 31 Jul 2022 19:02:13 +0900 Subject: [PATCH] Add compatibility note --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 3aad0a0..8052e49 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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.