-
Notifications
You must be signed in to change notification settings - Fork 1.7k
doc: GitHub PRs workflow #8926
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
doc: GitHub PRs workflow #8926
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
5dd4b2f
doc: GitHub PRs workflow
catenacyber b946d1e
Update doc/userguide/devguide/codebase/contributing/github-pr-workflo…
catenacyber 575a51d
Update doc/userguide/devguide/codebase/contributing/github-pr-workflo…
catenacyber 3086275
Update doc/userguide/devguide/codebase/contributing/github-pr-workflo…
catenacyber bd9667d
Update doc/userguide/devguide/codebase/contributing/github-pr-workflo…
catenacyber 50b81a9
Update doc/userguide/devguide/codebase/contributing/github-pr-workflo…
catenacyber 6dbe04f
Update doc/userguide/devguide/codebase/contributing/github-pr-workflo…
catenacyber 9370085
Update doc/userguide/devguide/codebase/contributing/github-pr-workflo…
catenacyber 5efb041
Update doc/userguide/devguide/codebase/contributing/github-pr-workflo…
catenacyber File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
42 changes: 42 additions & 0 deletions
42
doc/userguide/devguide/codebase/contributing/github-pr-workflow.rst
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| GitHub PRs workflow | ||
| =================== | ||
|
|
||
| Draft PRs | ||
| ~~~~~~~~~ | ||
|
|
||
| A PR should be marked as `draft` if it is not intended to be merged as is, | ||
| but is waiting for some sort of feedback. | ||
| The author of the PR should explicit what kind of feedback is expected (CI/QA run, discussion on the code, etc...) | ||
|
|
||
| GitHub filter is ``is:pr is:open draft:true sort:updated-asc`` | ||
|
|
||
| A draft may be closed if it has not been updated in two months. | ||
|
|
||
| Mergeable PRs | ||
| ~~~~~~~~~~~~~ | ||
|
|
||
| When a Pull Request is intended to be merged as is, the workflow is the following: | ||
| 1. get reviewed, and either request changes or get approved | ||
| 2. if approved, get staged in a next branch (with other PRs), wait for CI validation | ||
| (and eventually request changes if CI finds anything) | ||
catenacyber marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 3. get merged and closed | ||
|
|
||
| A newly created PR should match the filter | ||
| ``is:pr is:open draft:false review:none sort:updated-asc no:assignee`` | ||
| The whole team is responsible to assign a PR to someone precise within 2 weeks. | ||
|
|
||
| When someone gets assigned a PR, the PR should get a review status within 2 weeks: | ||
| either changes requested, approved, or assigned to someone else if more expertise is needed. | ||
catenacyber marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| GitHub filter for changes-requested PRs is ``is:pr is:open draft:false sort:updated-asc review:changes-requested`` | ||
catenacyber marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Such a PR may be closed if it has not been updated in two months. | ||
| It is expected that the author creates a new PR with a new version of the patch as described in :ref:`Pull Requests Criteria <pull-requests-criteria>`. | ||
catenacyber marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| #TODO filter does not work cf https://github.com/OISF/suricata/pull/8898 | ||
|
|
||
| GitHub filter for approved PRs that should go in a next branch is ``is:pr is:open draft:false sort:updated-asc review:approved`` | ||
catenacyber marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Command to get approved PRs is ``gh pr list --json number,reviewDecision --search "state:open type:pr -review:none" | jq '.[] | select(.reviewDecision=="")'`` | ||
catenacyber marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Once in approved state, the PRs are in the responsibility of the merger, along with the next branches/PRs. | ||
catenacyber marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,3 +6,4 @@ Contributing | |
|
|
||
| contribution-process | ||
| code-submission-process | ||
| github-pr-workflow | ||
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.
Uh oh!
There was an error while loading. Please reload this page.