jimeh/release-please-manifest-action
1
0
Fork 0
mirror of https://github.com/jimeh/release-please-manifest-action.git synced 2026-02-19 01:06:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): update features list and examples intro

Browse Source
This commit is contained in:
Jim Myhrberg
2023-05-08 01:46:41 +01:00
parent 5a9880757d
commit 48a1ac7188
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -38,16 +38,17 @@ running [release-please][] in [manifest mode][].
- Focuses on and only supports running release-please's manifest command.
- Optionally supports having release-please authenticate as a GitHub App.
- By default places release-please config and manifest files within the
top-level `.github` directory instead of in the repository root:
- `.github/.release-please-manifest.json`
- `.github/release-please-config.json`
- Defaults to looking for release-please's config and manifest files within the
top-level `.github` directory instead of in the repository root.
# Examples
All examples here assume you have places your `release-please-config.json` and
`.release-please-manifest.json` within the `.github` folder in the root of the
repository.
All examples assume you have placed your `release-please-config.json` and
`.release-please-manifest.json` within the `.github` directory in the root of
the repository.
See release-please's [manifest-releaser][manifest mode] documentation for
details about the config and manifest files.
## Basic (Actions Token)