feat: Toggle pull-request draft status

[peaceiris]

Close #436

Overview

My proposal about a REST API to toggle pull-request draft status (pulls.update: Change pull-request draft status · Issue #69 · octokit/rest.js) has been rejected since the GitHub API v4 (GraphQL API) has the ability to do that.

Unfortunately, an auto-generated access token called GITHUB_TOKEN seems not to have full control permission of the GraphQL API. We got the error Resource not accessible by integration with the GitHub API v4 and GITHUB_TOKEN. This problem may be related to the following thread.

• API v4 - Unable to Retrieve Email - Resource not accessible by integration - GitHub Ecosystem - GitHub Support Community

This pull-request uses a personal access token with a public_repo scope (for a public repository) as a workaround.

References

• convertPullRequestToDraft - Mutations - GitHub Docs
• markPullRequestReadyForReview - Mutations - GitHub Docs
• https://github.com/actions/toolkit/blob/%40actions/tool-cache%401.1.1/packages/github/README.md?plain=1#L32
  • octokit/graphql.js: GitHub GraphQL API client for browsers and Node
  • octokit/graphql-schema: GitHub’s GraphQL Schema with validation. Automatically updated.

Test This Implementation

Workflow

Provide a personal access token with a public_repo scope (for a public repository) as the GH_PAT secret.

name: Label Commenter

on:
  issues:
    types:
      - labeled
      - unlabeled
  pull_request_target:
    types:
      - labeled
      - unlabeled

permissions:
  contents: read
  issues: write
  pull-requests: write

jobs:
  comment:
    runs-on: ubuntu-20.04
    timeout-minutes: 1
    steps:
      - uses: actions/checkout@v2

      - name: Label Commenter
        uses: peaceiris/actions-label-commenter@06a7f624808ccde484c21bf2bc8fdbdf71a19339
        env:
          RUNNER_DEBUG: 1
        with:
          github_token: ${{ secrets.GH_PAT }}

Label Commenter Config

Add draft: true or draft: false to a pr field.

labels:
  - name: invalid
    labeled:
      pr:
        body: Thank you @{{ pull_request.user.login }} for suggesting this. Please follow the pull request templates.
        action: close
        draft: true

  - name: locked (heated)
    labeled:
      pr:
        body: |
          This pull-request has been **LOCKED** because of heated conversation!

          We appreciate exciting conversations, as long as they won't become too aggressive and/or emotional.
        locking: lock
        lock_reason: too heated
        draft: true
    unlabeled:
      pr:
        body: |
          This pull-request has been unlocked now.
        locking: unlock
        draft: false

[codecov]

Codecov Report

Merging #485 (aecdba5) into main (1c813ca) will decrease coverage by 4.40%.
The diff coverage is 80.00%.

@@            Coverage Diff             @@
##             main     #485      +/-   ##
==========================================
- Coverage   92.30%   87.90%   -4.41%     
==========================================
  Files           6        6              
  Lines         117      124       +7     
  Branches       18       22       +4     
==========================================
+ Hits          108      109       +1     
- Misses          9       15       +6     

Impacted Files	Coverage Δ
src/classes/action-processor.ts	83.78% <60.00%> (-4.10%)	⬇️
src/classes/comment.ts	89.79% <100.00%> (+0.21%)	⬆️
src/logger.ts	63.63% <100.00%> (-36.37%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c813ca...aecdba5. Read the comment docs.

[Andre601]

Got errors:
https://github.com/Readme-Workflows/recent-activity/pull/94/checks?check_run_id=3279903747

Current workflow file:
https://github.com/Readme-Workflows/recent-activity/blob/97a64b0dded82b0a130a249d24f3ee0980c8062c/.github/workflows/pr_comment.yml
(LABEL_COMMENTER is a PAT with public_repo scope)

Current label commenter file:
https://github.com/Readme-Workflows/recent-activity/blob/97a64b0dded82b0a130a249d24f3ee0980c8062c/.github/label-commenter-config.yml

Test PR:
Readme-Workflows/recent-activity#94

[peaceiris]

Thank you for the super quick try! Please use 06a7f624808ccde484c21bf2bc8fdbdf71a19339.

[Andre601]

It seems to work, but the downside is, that the user account of the PAT is used for the comment:

[peaceiris]

Yes. I totally agree with you. We have no way to avoid that behavior with a pat.

I think GITHUB_TOKEN is better than a personal access token. So, I am going to post a suggestion about permission improvement about GITHUB_TOKEN with GraphQL API to GitHub Community later.

[Andre601]

Yes. I totally agree with you. We have no way to avoid that behavior with a pat.

I think GITHUB_TOKEN is better than a personal access token. So, I am going to post a suggestion about permission improvement about GITHUB_TOKEN with GraphQL API to GitHub Community later.

https://github.51.almunity/t/allow-the-github-token-to-also-have-rights-for-converting-prs-to-draft-or-vice-versa/194555

You're welcome. (Comment with anything I missed to mention or explain)

[Andre601]

I for now have a dedicated account for the Repository where I want to use the draft feature and it seems to work fine.

[peaceiris]

Good!

[peaceiris]

This will be merged and released as the v1.11.0 with other new features. Watch v2.0.0 Milestone. We can continue to use 06a7f624808ccde484c21bf2bc8fdbdf71a19339 until the v2.0.0 will be published.