Skip to content
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.

Sign up for GitHub

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

Add PR checklist workflow #7699

Merged
merged 7 commits into from
Jul 15, 2024
Merged

Add PR checklist workflow #7699

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b12bec9
Add PR checklist workflow
kolchfa-aws Jul 12, 2024
0a317a2
Assign to user instead of owner
kolchfa-aws Jul 12, 2024
56833d6
Testing
kolchfa-aws Jul 12, 2024
04fba9a
Remove test
kolchfa-aws Jul 12, 2024
e94a41d
Apply suggestions from code review
kolchfa-aws Jul 12, 2024
93f343d
If a PR is submitted by a doc team member, assign that member
kolchfa-aws Jul 13, 2024
c7f8b11
Remove test
kolchfa-aws Jul 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/pr_checklist.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: PR Checklist

on:
pull_request:
types: [opened]

jobs:
add-checklist:
runs-on: ubuntu-latest

steps:
- name: Comment PR with checklist
uses: peter-evans/create-or-update-comment@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.pull_request.number }}
body: |
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.
Copy link
Collaborator

@natebower natebower Jul 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these match the GitHub labels? In other words, how will these states be apparent to the author?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of them do (like "In progress", "Doc review", and "Tech review"). "Editorial review" label is "Final editorial review" but I'd rather change the label if needed because the goal here is to provide some hints with minimum number of words.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of them do (like "In progress", "Doc review", and "Tech review"). "Editorial review" label is "Final editorial review" but I'd rather change the label if needed because the goal here is to provide some hints with minimum number of words.

Agreed - I changed the label.


Before you mark the PR ready for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a [maintainer](https://github.com/opensearch-project/documentation-website/blob/main/MAINTAINERS.md).
kolchfa-aws marked this conversation as resolved.
Show resolved Hide resolved
natebower marked this conversation as resolved.
Show resolved Hide resolved

**When you're ready for doc review, tag the assignee of this PR**. The doc reviewer may push edits to the PR directly, or leave comments and editorial suggestions for you to approve, make changes, and commit yourself (let us know in a comment if you have a preference.) The doc reviewer will arrange for an editorial review.
kolchfa-aws marked this conversation as resolved.
Show resolved Hide resolved

- name: Auto assign PR to repo owner
uses: actions/github-script@v6
with:
script: |
github.rest.issues.addAssignees({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
assignees: 'hdhalter'
})
Loading