From 4d3960dc5c90f3519878e7f8636e8586526ad66d Mon Sep 17 00:00:00 2001 From: Chris Reynolds Date: Fri, 22 Nov 2024 10:12:03 -0700 Subject: [PATCH] Open PRs as draft (#4) * create PR as a draft * drop default token there is no default, it's required. also this environment variable doesn't exist, so it can't be used as a default * add note that PRs will be in draft by default --- README.md | 4 +--- action.yml | 3 ++- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 12aa84f..0aa231e 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ _For internal use only._ This action will not work for and is not intended to be used on non-`pantheon-systems` repositories. -This Action is intended to be used on Pantheon repositories to automatically generate a Docs Release Note PR when a new release is created. By default, the action will pull the content of the release note from the GitHub release and add the appropriate release note syntax around it to standardize release notes for Pantheon OSS projects. +This Action is intended to be used on Pantheon repositories to automatically generate a Docs Release Note PR (in draft form) when a new release is created. By default, the action will pull the content of the release note from the GitHub release and add the appropriate release note syntax around it to standardize release notes for Pantheon OSS projects. ## Usage @@ -54,8 +54,6 @@ A valid Personal Access Token (PAT) with the `repo` and `workflow` scopes is req ### `github_token` (**Required**) A GitHub Personal Access Token with access to the Documentation repository. Used to create the pull request in the documentation repository. -default: `${{ env.GH_TOKEN }}` - ### `categories` (**Required**) Comma-separated list of categories for the release note. For a complete list of categories and descriptions, see https://github.com/pantheon-systems/documentation/blob/main/source/releasenotescategories/releaseNoteCategories.json diff --git a/action.yml b/action.yml index 78d53b6..8a2a3bc 100644 --- a/action.yml +++ b/action.yml @@ -167,4 +167,5 @@ runs: --base main \ --head ${PR_BRANCH} \ --title "${PR_TITLE}" \ - --body "${PR_BODY}" + --body "${PR_BODY}" \ + --draft