From e5c76ffb5afe9e27434f93429a560e27d2829d44 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Sat, 1 Aug 2020 14:18:57 -0400 Subject: [PATCH] Add documentation for the `commitish` option Closes #83 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 93486e3e..2641d60c 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Create a workflow `.yml` file in your `.github/workflows` directory. An [example For more information on these inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input) - `tag_name`: The name of the tag for this release +- `commitish`: The SHA or reference to create the release tag from if it does not exist. Defaults to the HEAD of the repository's default branch. - `release_name`: The name of the release - `body`: Text describing the contents of the release. Optional, and not needed if using `body_path`. - `body_path`: A file with contents describing the release. Optional, and not needed if using `body`.