Skip to content

Commit

Permalink
Open PRs as draft (#4)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
jazzsequence authored Nov 22, 2024
1 parent 4d0cbec commit 4d3960d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -167,4 +167,5 @@ runs:
--base main \
--head ${PR_BRANCH} \
--title "${PR_TITLE}" \
--body "${PR_BODY}"
--body "${PR_BODY}" \
--draft

0 comments on commit 4d3960d

Please sign in to comment.