From 61b33c7911ea94dbb9d2ad2df541553e67b4d31d Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Fri, 5 May 2023 00:10:03 +0100 Subject: [PATCH] docs(readme): add basic readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b46026d --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# release-please-action + +Composite [GitHub Action][1] which wraps [release-please-action][2] and +[github-app-token][3] actions, with some opinionated default settings. + +[1]: https://github.com/features/actions +[2]: https://github.com/google-github-actions/release-please-action +[3]: https://github.com/tibdex/github-app-token + +## Features + +- Makes it easy to run release-please as a GitHub App. +- Defaults to placing release place config and manifests within the `.github` + folder in the repository root: + - `.release-please-manifest.json` -> `.github/release-please-manifest.json` + - `release-please-config.json` -> `.github/release-please-config.json`