docs: Document how to improve close-and-reopen user experience #1084
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peter-evans
requested changes
Mar 9, 2022
| @@ -144,7 +144,7 @@ Pull requests created by the action using the default `GITHUB_TOKEN` cannot trig | |||
|
|
|||
| There are a number of workarounds with different pros and cons. | |||
|
|
|||
| - Use the default `GITHUB_TOKEN` and allow the action to create pull requests that have no checks enabled. Manually close pull requests and immediately reopen them. This will enable `on: pull_request` workflows to run and be added as checks. | |||
| - Use the default `GITHUB_TOKEN` and allow the action to create pull requests that have no checks enabled. Manually close pull requests and immediately reopen them. This will enable `on: pull_request` workflows to run and be added as checks. (Adding `draft: true` and a note about a close-and-reopen cycle to the message in `body` may help prevent human merges of pull requests where needed workflows have not yet been run.) | |||
There was a problem hiding this comment.
Using draft PRs is a good tip. 🏅
I'm conscious of adding too much detail to the documentation, so I would just like to simplify the tip a bit.
Suggested change
| - Use the default `GITHUB_TOKEN` and allow the action to create pull requests that have no checks enabled. Manually close pull requests and immediately reopen them. This will enable `on: pull_request` workflows to run and be added as checks. (Adding `draft: true` and a note about a close-and-reopen cycle to the message in `body` may help prevent human merges of pull requests where needed workflows have not yet been run.) | |
| - Use the default `GITHUB_TOKEN` and allow the action to create pull requests that have no checks enabled. Manually close pull requests and immediately reopen them. This will enable `on: pull_request` workflows to run and be added as checks. Alternatively, create draft pull requests with `draft: true`. When the pull request is opened for review, checks will run. |
There was a problem hiding this comment.
I'm conscious of adding too much detail to the documentation, so I would just like to simplify the tip a bit.
Hi @peter-evans, I understand and it's not totally unexpected. I am happy to adjust but:
- I tried earlier today myself: Just pressing the "Ready to review" button does not seem to trigger any
on: pull_requestworkflows (while that was, what I had originally hoped for). It needed a closed and re-open and the suggested simplification reads as if the pressing of "Ready to review" would be the key and sufficient. Am I missing something? - I would want to replace "create draft" by "create [a] draft"
How would you like to continue?
There was a problem hiding this comment.
I just assumed pressing "Ready to review" is a state change for the PR from draft to open and would kick off checks, but clearly not if you've tried it.
Ok, let's just go with your original text then, since the tip should be focused on preventing human error.
peter-evans
approved these changes
Mar 9, 2022
0xMRTT
added a commit
to GradienceTeam/Gradience
that referenced
this pull request
Aug 19, 2022
Bumps peter-evans/create-pull-request from 3 to 4. Release notes Sourced from peter-evans/create-pull-request's releases. Create Pull Request v4.0.0 Breaking changes The add-paths input no longer accepts -A as a valid value. When committing all new and modified files the add-paths input should be omitted. If using self-hosted runners or GitHub Enterprise Server, there are minimum requirements for v4 to run. See "What's new" below for details. What's new Updated runtime to Node.js 16 The action now requires a minimum version of v2.285.0 for the Actions Runner. If using GitHub Enterprise Server, the action requires GHES 3.4 or later. What's Changed README.md: Add word "permissions" to part on GITHUB_TOKEN by @hartwork in peter-evans/create-pull-request#1082 docs: Document how to improve close-and-reopen user experience by @hartwork in peter-evans/create-pull-request#1084 README.md: Skip follow-up steps if there is no pull request by @hartwork in peter-evans/create-pull-request#1083 v4 by @peter-evans in peter-evans/create-pull-request#1099 New Contributors @hartwork made their first contribution in peter-evans/create-pull-request#1082 Full Changelog: peter-evans/[email protected] Create Pull Request v3.14.0 This release reverts a commit made to bump the runtime to node 16. It inadvertently caused an issue for users on GitHub Enterprise. Apologies. 🙇♂️ What's Changed feat: revert update action runtime to node 16 by @peter-evans peter-evans/create-pull-request@18f7dc0 Full Changelog: peter-evans/[email protected] Create Pull Request v3.13.0 What's Changed Document that draft status changes are not reflected by @willthames in peter-evans/create-pull-request#1064 fix: remove unused draft param from pull update by @peter-evans in peter-evans/create-pull-request#1065 Update action runtime to node 16 by @sibiraj-s in peter-evans/create-pull-request#1074 New Contributors @willthames made their first contribution in peter-evans/create-pull-request#1064 @sibiraj-s made their first contribution in peter-evans/create-pull-request#1074 Full Changelog: peter-evans/[email protected] Create Pull Request v3.12.1 What's Changed ci: remove workflow by @peter-evans in peter-evans/create-pull-request#1046 fix: add '--' to checkout command to avoid ambiguity by @kenji-miyake in peter-evans/create-pull-request#1051 New Contributors @kenji-miyake made their first contribution in peter-evans/create-pull-request#1051 ... (truncated) Commits 18f9043 build: update distribution (#1216) 2721abb fix: handle nothing to commit when autocrlf is set (#1211) 20dac2e build: update distribution (#1208) 8557470 feat: support no_proxy environment variable (#1205) 10db758 docs: add info about workflow permissions 5a6b153 docs: clearer description of update behaviour 923ad83 force tryFetch (#1189) f094b77 fix: avoid issue with case sensitivity of repo names (#1179) af7c021 docs: shorten quote 97872c4 docs: update GA quote/ref in concepts-guidelines.md (#1169) Additional commits viewable in compare view Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase. Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: @dependabot rebase will rebase this PR @dependabot recreate will recreate this PR, overwriting any edits that have been made to it @dependabot merge will merge this PR after your CI passes on it @dependabot squash and merge will squash and merge this PR after your CI passes on it @dependabot cancel merge will cancel a previously requested merge and block automerging @dependabot reopen will reopen this PR if it is closed @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
aleksandrychev
pushed a commit
to aleksandrychev/create-pull-request
that referenced
this pull request
Mar 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the approach I am currently using myself at https://github.com/hartwork/xiangqi-setup/pull/58/files#diff-631ddddad3ce2984341daa018557dc2604e082ff6183250503f7eb24415d2f7fR48-R55 and two other places. Just an idea, happy to reword as needed.