README.md

👮 Check User Permission

🚀 How to use?

name: Check User Permission

on:
  issues:
    types: [opened, edited]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions-cool/check-user-permission@v2

Input

Name	Desc	Type	Required
token	GitHub token	string	✖
require	Test whether the user meets the required permission	string	✖
username	Obtained from the context by default, can also be customized to pass in	string	✖
check-bot	Check whether the user is a bot	boolean	✖
check-contributor	Check whether the user is contributor	boolean	✖
error-if-missing	Error if require or check if false	boolean	✖

• User permission: admin > write > read
• username support github context
  • actor: The Default
  • triggering_actor: The username of the user that initiated the workflow run even re-run
  • Example: username: github.triggering_actor

Output

• user-permission: read | write | admin
• require-result: The result of require true | false
• check-result: The result of check true | false

How to use?

• https://github.com/actions-cool/issues-helper#outputs-%E4%BD%BF%E7%94%A8
• https://github.com/actions-cool/check-user-permission/blob/main/.github/workflows/check-permission.yml
• https://github.com/actions-cool/test-ci/blob/main/.github/workflows/test-check-user.yml

⚡ Feedback

You are very welcome to try it out and put forward your comments. You can use the following methods:

• Report bugs or consult with Issue
• Submit Pull Request to improve the code of check-user-permission

欢迎加入 钉钉交流群

Changelog

CHANGELOG

LICENSE

MIT