From 19455addd5c1c68c5f17fd7768fac1396bda3d4e Mon Sep 17 00:00:00 2001 From: smoia Date: Wed, 14 Oct 2020 14:53:13 +0200 Subject: [PATCH 1/5] Add workflow to publish main reviewer checklist --- .github/workflows/main-reviewer.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/main-reviewer.yml diff --git a/.github/workflows/main-reviewer.yml b/.github/workflows/main-reviewer.yml new file mode 100644 index 000000000..4d6a16aeb --- /dev/null +++ b/.github/workflows/main-reviewer.yml @@ -0,0 +1,25 @@ +# This workflows print a message to give the Main Reviewer a checklist (before merge) + +name: Main Reviewer + +on: + pull_request: + types: [assigned] + +jobs: + deploy: + # Not totally sure we need this + runs-on: ubuntu-18.04 + + steps: + - name: Replace reviewer name in message template + uses: falnyr/replace-env-vars-action@master + env: + MAINREV: ${{ github.event.issue.assignees }} + with: .github/workflows/main_rev_checklist.md + - name: Post filled template as comment + uses: harupy/comment-on-pr@master + env: + GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} + with: + filename: main_rev_checklist.md From c8c7109469c6f2438c704c4b9b2e7dbeb61cfc78 Mon Sep 17 00:00:00 2001 From: smoia Date: Wed, 14 Oct 2020 17:40:59 +0200 Subject: [PATCH 2/5] Create template for checklist --- .github/workflows/main_rev_checklist.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/main_rev_checklist.md diff --git a/.github/workflows/main_rev_checklist.md b/.github/workflows/main_rev_checklist.md new file mode 100644 index 000000000..cab32aecd --- /dev/null +++ b/.github/workflows/main_rev_checklist.md @@ -0,0 +1,25 @@ +Hello @__MAINREV__! + +You've been assigned to this PR, which means that you've been nominated Main Reviewer! (Lucky you! :ta-da: :ta-da: :ta-da:) + +As a Main Reviewer, you are a bit more responsible for the quality of this PR and of the project in general than your fellow Reviewers. If you have any doubt, check [this section on reviewing](https://phys2bids.readthedocs.io/en/latest/contributorfile.html#reviewing) and [this section on being the Main Reviewer](https://phys2bids.readthedocs.io/en/latest/contributorfile.html#mainreviewer) of the documents. + +Before merging this PR, please check that: +- [ ] The PR passes all the CircleCI/Azure tests. +- [ ] The content respects the [Style Guide](https://phys2bids.readthedocs.io/en/latest/contributorfile.html#styling). +- [ ] If the PR contains documentation, your local build is right. +- If the PR contains code changes: + - [ ] Content and changes are adequately documented in the docstrings. + - [ ] User documentation is being updated accordingly - or a related issue has been opened. + - [ ] The adequate tests have been added/updated - or a related issue has been opened *if coverage doesn't drop below 90%*. +- [ ] The PR and the reviews are harmonious with the rest of the repository, especially in that **they don't introduce repetitions** +- [ ] The title of the PR is clear enough to describe a release content. +- [ ] The labels are correct - and they will (or won't) trigger the correct `auto` release. +- [ ] The PR received the amount of approvals necessaries to be merged. + +After you merged this PR, please check that: +- [ ] The Author(s) and Reviewers contributions have been updated in the README. +- [ ] The updates (in code, tests and documentation) have appened correctly. +- [ ] If they had to, the tag was created, the release was cut, and the pypi version got updated. + +Thank you! \ No newline at end of file From ae9b79f3377f712b468d1f2785083bd072ba765c Mon Sep 17 00:00:00 2001 From: smoia Date: Wed, 14 Oct 2020 17:42:39 +0200 Subject: [PATCH 3/5] Add comments --- .github/workflows/main-reviewer.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main-reviewer.yml b/.github/workflows/main-reviewer.yml index 4d6a16aeb..99cb6b47d 100644 --- a/.github/workflows/main-reviewer.yml +++ b/.github/workflows/main-reviewer.yml @@ -1,13 +1,13 @@ # This workflows print a message to give the Main Reviewer a checklist (before merge) -name: Main Reviewer +name: Main Reviewer Checklist on: pull_request: types: [assigned] jobs: - deploy: + checklist: # Not totally sure we need this runs-on: ubuntu-18.04 @@ -15,6 +15,7 @@ jobs: - name: Replace reviewer name in message template uses: falnyr/replace-env-vars-action@master env: + # This is a wild guess. Probably it's also wrong. MAINREV: ${{ github.event.issue.assignees }} with: .github/workflows/main_rev_checklist.md - name: Post filled template as comment From 73c10417bbd8fa88491af19559cc4ebe46503583 Mon Sep 17 00:00:00 2001 From: smoia Date: Wed, 14 Oct 2020 17:44:37 +0200 Subject: [PATCH 4/5] Move comment --- .github/workflows/main-reviewer.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main-reviewer.yml b/.github/workflows/main-reviewer.yml index 99cb6b47d..25ad93955 100644 --- a/.github/workflows/main-reviewer.yml +++ b/.github/workflows/main-reviewer.yml @@ -14,8 +14,8 @@ jobs: steps: - name: Replace reviewer name in message template uses: falnyr/replace-env-vars-action@master - env: # This is a wild guess. Probably it's also wrong. + env: MAINREV: ${{ github.event.issue.assignees }} with: .github/workflows/main_rev_checklist.md - name: Post filled template as comment From 633692225666e90edfce46c3e73c5be8e5b83606 Mon Sep 17 00:00:00 2001 From: smoia Date: Wed, 14 Oct 2020 17:46:31 +0200 Subject: [PATCH 5/5] Reformat --- .github/workflows/main-reviewer.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/main-reviewer.yml b/.github/workflows/main-reviewer.yml index 25ad93955..33959d7b2 100644 --- a/.github/workflows/main-reviewer.yml +++ b/.github/workflows/main-reviewer.yml @@ -14,13 +14,13 @@ jobs: steps: - name: Replace reviewer name in message template uses: falnyr/replace-env-vars-action@master - # This is a wild guess. Probably it's also wrong. - env: - MAINREV: ${{ github.event.issue.assignees }} - with: .github/workflows/main_rev_checklist.md + env: + # This is a wild guess. Probably it's also wrong. + MAINREV: ${{ github.event.issue.assignees }} + with: .github/workflows/main_rev_checklist.md - name: Post filled template as comment uses: harupy/comment-on-pr@master - env: - GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} - with: - filename: main_rev_checklist.md + env: + GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} + with: + filename: main_rev_checklist.md