From 776aec3f7e314b24c6e594289f0f8b419d42288b Mon Sep 17 00:00:00 2001 From: Timon van Spronsen Date: Mon, 23 Dec 2019 17:18:05 +0100 Subject: [PATCH] Move GitHub App usage doc out of README to separate doc --- README.md | 12 +----------- docs/github-app.md | 11 +++++++++++ 2 files changed, 12 insertions(+), 11 deletions(-) create mode 100644 docs/github-app.md diff --git a/README.md b/README.md index 92f7a2733a..deba92e60c 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,8 @@ --- -[![NPM package](https://img.shields.io/npm/v/release-drafter-github-app.svg)](https://www.npmjs.com/package/release-drafter-github-app) - ## Usage -### GitHub Actions - You can use the [Release Drafter GitHub Action](https://github.com/marketplace/actions/release-drafter) in a [GitHub Actions Workflow](https://help.github.com/en/articles/about-github-actions) by configuring a YAML-based workflow file, e.g. `.github/workflows/release-drafter.yml`, with the following: ```yaml @@ -33,9 +29,7 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` -### GitHub App - -You can also install the [Release Drafter GitHub App](https://github.com/apps/release-drafter), choosing the repositories for which you want releases automatically created. +If you're unable to use GitHub Actions, you can use the Release Drafter GitHub App. Please refer to the [Release Drafter GitHub App documentation](docs/github-app.md) for more information. ## Configuration @@ -191,10 +185,6 @@ If your project doesn't follow [Semantic Versioning](https://semver.org) you can For example, if your project doesn't use patch version numbers, you can set `version-template` to `$MAJOR.$MINOR`. If the current release is version 1.0, then `$NEXT_MINOR_VERSION` will be `1.1`. -## GitHub Installation Permissions - -Release Drafter requires full write, because GitHub does not offer a limited scope for only writing releases. **Don't install Release Drafter to your entire GitHub account — only add the repositories you want to draft releases on.** - ## Developing If you have Node v10+ installed locally, you can run the tests, and a local app, using the following commands: diff --git a/docs/github-app.md b/docs/github-app.md new file mode 100644 index 0000000000..1673d2c1d9 --- /dev/null +++ b/docs/github-app.md @@ -0,0 +1,11 @@ +# Release Drafter GitHub App [![NPM package](https://img.shields.io/npm/v/release-drafter-github-app.svg)](https://www.npmjs.com/package/release-drafter-github-app) + +If you're unable to use GitHub Actions, you can use the now deprecated [Release Drafter GitHub App](https://github.com/apps/release-drafter). Keep in mind that the Release Drafter GitHub App won't be receiving any new features (see: [#335](https://github.com/release-drafter/release-drafter/issues/335)). + +## Usage + +Install the [Release Drafter GitHub App](https://github.com/apps/release-drafter) and choose the repositories for which you want releases automatically created. + +## Installation permissions + +Release Drafter requires full write access, because GitHub does not offer a limited scope for only writing releases. **Don't install Release Drafter to your entire GitHub account — only add the repositories you want to draft releases on.**