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

Jump to bottom

docs: Updated README.md for better usage clarity #52

Merged
merged 1 commit into from
Jan 27, 2021
Merged

docs: Updated README.md for better usage clarity #52

merged 1 commit into from
Jan 27, 2021

Conversation

fuxingloh
Copy link
Owner

No description provided.

@github-actions
Copy link

Debug Payload Information 
{
  "payload": {
    "action": "opened",
    "number": 52,
    "pull_request": {
      "_links": {
        "comments": {
          "href": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52/comments"
        },
        "commits": {
          "href": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/52/commits"
        },
        "html": {
          "href": "https://github.com/fuxingloh/multi-labeler/pull/52"
        },
        "issue": {
          "href": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52"
        },
        "review_comment": {
          "href": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/comments{/number}"
        },
        "review_comments": {
          "href": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/52/comments"
        },
        "self": {
          "href": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/52"
        },
        "statuses": {
          "href": "https://api.github.com/repos/fuxingloh/multi-labeler/statuses/99d8f195034b5e6f4b59c83443e96966ba3e818c"
        }
      },
      "active_lock_reason": null,
      "additions": 23,
      "assignee": null,
      "assignees": [],
      "author_association": "OWNER",
      "base": {
        "label": "fuxingloh:main",
        "ref": "main",
        "repo": {
          "allow_merge_commit": false,
          "allow_rebase_merge": false,
          "allow_squash_merge": true,
          "archive_url": "https://api.github.com/repos/fuxingloh/multi-labeler/{archive_format}{/ref}",
          "archived": false,
          "assignees_url": "https://api.github.com/repos/fuxingloh/multi-labeler/assignees{/user}",
          "blobs_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/blobs{/sha}",
          "branches_url": "https://api.github.com/repos/fuxingloh/multi-labeler/branches{/branch}",
          "clone_url": "https://github.com/fuxingloh/multi-labeler.git",
          "collaborators_url": "https://api.github.com/repos/fuxingloh/multi-labeler/collaborators{/collaborator}",
          "comments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/comments{/number}",
          "commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/commits{/sha}",
          "compare_url": "https://api.github.com/repos/fuxingloh/multi-labeler/compare/{base}...{head}",
          "contents_url": "https://api.github.com/repos/fuxingloh/multi-labeler/contents/{+path}",
          "contributors_url": "https://api.github.com/repos/fuxingloh/multi-labeler/contributors",
          "created_at": "2021-01-13T09:32:38Z",
          "default_branch": "main",
          "delete_branch_on_merge": true,
          "deployments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/deployments",
          "description": "Multi labeler for title, body, comments, commit messages, branch, author or files with automated status checks.",
          "disabled": false,
          "downloads_url": "https://api.github.com/repos/fuxingloh/multi-labeler/downloads",
          "events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/events",
          "fork": false,
          "forks": 0,
          "forks_count": 0,
          "forks_url": "https://api.github.com/repos/fuxingloh/multi-labeler/forks",
          "full_name": "fuxingloh/multi-labeler",
          "git_commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/commits{/sha}",
          "git_refs_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/refs{/sha}",
          "git_tags_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/tags{/sha}",
          "git_url": "git://github.com/fuxingloh/multi-labeler.git",
          "has_downloads": true,
          "has_issues": true,
          "has_pages": false,
          "has_projects": true,
          "has_wiki": true,
          "homepage": "",
          "hooks_url": "https://api.github.com/repos/fuxingloh/multi-labeler/hooks",
          "html_url": "https://github.com/fuxingloh/multi-labeler",
          "id": 329257641,
          "issue_comment_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/comments{/number}",
          "issue_events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/events{/number}",
          "issues_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues{/number}",
          "keys_url": "https://api.github.com/repos/fuxingloh/multi-labeler/keys{/key_id}",
          "labels_url": "https://api.github.com/repos/fuxingloh/multi-labeler/labels{/name}",
          "language": "TypeScript",
          "languages_url": "https://api.github.com/repos/fuxingloh/multi-labeler/languages",
          "license": {
            "key": "mit",
            "name": "MIT License",
            "node_id": "MDc6TGljZW5zZTEz",
            "spdx_id": "MIT",
            "url": "https://api.github.com/licenses/mit"
          },
          "merges_url": "https://api.github.com/repos/fuxingloh/multi-labeler/merges",
          "milestones_url": "https://api.github.com/repos/fuxingloh/multi-labeler/milestones{/number}",
          "mirror_url": null,
          "name": "multi-labeler",
          "node_id": "MDEwOlJlcG9zaXRvcnkzMjkyNTc2NDE=",
          "notifications_url": "https://api.github.com/repos/fuxingloh/multi-labeler/notifications{?since,all,participating}",
          "open_issues": 1,
          "open_issues_count": 1,
          "owner": {
            "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
            "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
            "followers_url": "https://api.github.com/users/fuxingloh/followers",
            "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
            "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
            "gravatar_id": "",
            "html_url": "https://github.com/fuxingloh",
            "id": 4266087,
            "login": "fuxingloh",
            "node_id": "MDQ6VXNlcjQyNjYwODc=",
            "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
            "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
            "repos_url": "https://api.github.com/users/fuxingloh/repos",
            "site_admin": false,
            "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
            "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
            "type": "User",
            "url": "https://api.github.com/users/fuxingloh"
          },
          "private": false,
          "pulls_url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls{/number}",
          "pushed_at": "2021-01-27T14:03:24Z",
          "releases_url": "https://api.github.com/repos/fuxingloh/multi-labeler/releases{/id}",
          "size": 1224,
          "ssh_url": "git@github.com:fuxingloh/multi-labeler.git",
          "stargazers_count": 3,
          "stargazers_url": "https://api.github.com/repos/fuxingloh/multi-labeler/stargazers",
          "statuses_url": "https://api.github.com/repos/fuxingloh/multi-labeler/statuses/{sha}",
          "subscribers_url": "https://api.github.com/repos/fuxingloh/multi-labeler/subscribers",
          "subscription_url": "https://api.github.com/repos/fuxingloh/multi-labeler/subscription",
          "svn_url": "https://github.com/fuxingloh/multi-labeler",
          "tags_url": "https://api.github.com/repos/fuxingloh/multi-labeler/tags",
          "teams_url": "https://api.github.com/repos/fuxingloh/multi-labeler/teams",
          "trees_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/trees{/sha}",
          "updated_at": "2021-01-27T08:04:31Z",
          "url": "https://api.github.com/repos/fuxingloh/multi-labeler",
          "watchers": 3,
          "watchers_count": 3
        },
        "sha": "f3e20f676a3d8ab0255e439c5c9a8d2ebcb17c25",
        "user": {
          "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
          "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
          "followers_url": "https://api.github.com/users/fuxingloh/followers",
          "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
          "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
          "gravatar_id": "",
          "html_url": "https://github.com/fuxingloh",
          "id": 4266087,
          "login": "fuxingloh",
          "node_id": "MDQ6VXNlcjQyNjYwODc=",
          "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
          "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
          "repos_url": "https://api.github.com/users/fuxingloh/repos",
          "site_admin": false,
          "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
          "type": "User",
          "url": "https://api.github.com/users/fuxingloh"
        }
      },
      "body": "",
      "changed_files": 1,
      "closed_at": null,
      "comments": 0,
      "comments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52/comments",
      "commits": 1,
      "commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/52/commits",
      "created_at": "2021-01-27T14:03:32Z",
      "deletions": 5,
      "diff_url": "https://github.com/fuxingloh/multi-labeler/pull/52.diff",
      "draft": false,
      "head": {
        "label": "fuxingloh:docs/readme",
        "ref": "docs/readme",
        "repo": {
          "allow_merge_commit": false,
          "allow_rebase_merge": false,
          "allow_squash_merge": true,
          "archive_url": "https://api.github.com/repos/fuxingloh/multi-labeler/{archive_format}{/ref}",
          "archived": false,
          "assignees_url": "https://api.github.com/repos/fuxingloh/multi-labeler/assignees{/user}",
          "blobs_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/blobs{/sha}",
          "branches_url": "https://api.github.com/repos/fuxingloh/multi-labeler/branches{/branch}",
          "clone_url": "https://github.com/fuxingloh/multi-labeler.git",
          "collaborators_url": "https://api.github.com/repos/fuxingloh/multi-labeler/collaborators{/collaborator}",
          "comments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/comments{/number}",
          "commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/commits{/sha}",
          "compare_url": "https://api.github.com/repos/fuxingloh/multi-labeler/compare/{base}...{head}",
          "contents_url": "https://api.github.com/repos/fuxingloh/multi-labeler/contents/{+path}",
          "contributors_url": "https://api.github.com/repos/fuxingloh/multi-labeler/contributors",
          "created_at": "2021-01-13T09:32:38Z",
          "default_branch": "main",
          "delete_branch_on_merge": true,
          "deployments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/deployments",
          "description": "Multi labeler for title, body, comments, commit messages, branch, author or files with automated status checks.",
          "disabled": false,
          "downloads_url": "https://api.github.com/repos/fuxingloh/multi-labeler/downloads",
          "events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/events",
          "fork": false,
          "forks": 0,
          "forks_count": 0,
          "forks_url": "https://api.github.com/repos/fuxingloh/multi-labeler/forks",
          "full_name": "fuxingloh/multi-labeler",
          "git_commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/commits{/sha}",
          "git_refs_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/refs{/sha}",
          "git_tags_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/tags{/sha}",
          "git_url": "git://github.com/fuxingloh/multi-labeler.git",
          "has_downloads": true,
          "has_issues": true,
          "has_pages": false,
          "has_projects": true,
          "has_wiki": true,
          "homepage": "",
          "hooks_url": "https://api.github.com/repos/fuxingloh/multi-labeler/hooks",
          "html_url": "https://github.com/fuxingloh/multi-labeler",
          "id": 329257641,
          "issue_comment_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/comments{/number}",
          "issue_events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/events{/number}",
          "issues_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues{/number}",
          "keys_url": "https://api.github.com/repos/fuxingloh/multi-labeler/keys{/key_id}",
          "labels_url": "https://api.github.com/repos/fuxingloh/multi-labeler/labels{/name}",
          "language": "TypeScript",
          "languages_url": "https://api.github.com/repos/fuxingloh/multi-labeler/languages",
          "license": {
            "key": "mit",
            "name": "MIT License",
            "node_id": "MDc6TGljZW5zZTEz",
            "spdx_id": "MIT",
            "url": "https://api.github.com/licenses/mit"
          },
          "merges_url": "https://api.github.com/repos/fuxingloh/multi-labeler/merges",
          "milestones_url": "https://api.github.com/repos/fuxingloh/multi-labeler/milestones{/number}",
          "mirror_url": null,
          "name": "multi-labeler",
          "node_id": "MDEwOlJlcG9zaXRvcnkzMjkyNTc2NDE=",
          "notifications_url": "https://api.github.com/repos/fuxingloh/multi-labeler/notifications{?since,all,participating}",
          "open_issues": 1,
          "open_issues_count": 1,
          "owner": {
            "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
            "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
            "followers_url": "https://api.github.com/users/fuxingloh/followers",
            "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
            "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
            "gravatar_id": "",
            "html_url": "https://github.com/fuxingloh",
            "id": 4266087,
            "login": "fuxingloh",
            "node_id": "MDQ6VXNlcjQyNjYwODc=",
            "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
            "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
            "repos_url": "https://api.github.com/users/fuxingloh/repos",
            "site_admin": false,
            "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
            "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
            "type": "User",
            "url": "https://api.github.com/users/fuxingloh"
          },
          "private": false,
          "pulls_url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls{/number}",
          "pushed_at": "2021-01-27T14:03:24Z",
          "releases_url": "https://api.github.com/repos/fuxingloh/multi-labeler/releases{/id}",
          "size": 1224,
          "ssh_url": "git@github.com:fuxingloh/multi-labeler.git",
          "stargazers_count": 3,
          "stargazers_url": "https://api.github.com/repos/fuxingloh/multi-labeler/stargazers",
          "statuses_url": "https://api.github.com/repos/fuxingloh/multi-labeler/statuses/{sha}",
          "subscribers_url": "https://api.github.com/repos/fuxingloh/multi-labeler/subscribers",
          "subscription_url": "https://api.github.com/repos/fuxingloh/multi-labeler/subscription",
          "svn_url": "https://github.com/fuxingloh/multi-labeler",
          "tags_url": "https://api.github.com/repos/fuxingloh/multi-labeler/tags",
          "teams_url": "https://api.github.com/repos/fuxingloh/multi-labeler/teams",
          "trees_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/trees{/sha}",
          "updated_at": "2021-01-27T08:04:31Z",
          "url": "https://api.github.com/repos/fuxingloh/multi-labeler",
          "watchers": 3,
          "watchers_count": 3
        },
        "sha": "99d8f195034b5e6f4b59c83443e96966ba3e818c",
        "user": {
          "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
          "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
          "followers_url": "https://api.github.com/users/fuxingloh/followers",
          "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
          "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
          "gravatar_id": "",
          "html_url": "https://github.com/fuxingloh",
          "id": 4266087,
          "login": "fuxingloh",
          "node_id": "MDQ6VXNlcjQyNjYwODc=",
          "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
          "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
          "repos_url": "https://api.github.com/users/fuxingloh/repos",
          "site_admin": false,
          "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
          "type": "User",
          "url": "https://api.github.com/users/fuxingloh"
        }
      },
      "html_url": "https://github.com/fuxingloh/multi-labeler/pull/52",
      "id": 562528801,
      "issue_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52",
      "labels": [],
      "locked": false,
      "maintainer_can_modify": false,
      "merge_commit_sha": null,
      "mergeable": null,
      "mergeable_state": "unknown",
      "merged": false,
      "merged_at": null,
      "merged_by": null,
      "milestone": null,
      "node_id": "MDExOlB1bGxSZXF1ZXN0NTYyNTI4ODAx",
      "number": 52,
      "patch_url": "https://github.com/fuxingloh/multi-labeler/pull/52.patch",
      "rebaseable": null,
      "requested_reviewers": [],
      "requested_teams": [],
      "review_comment_url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/comments{/number}",
      "review_comments": 0,
      "review_comments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/52/comments",
      "state": "open",
      "statuses_url": "https://api.github.com/repos/fuxingloh/multi-labeler/statuses/99d8f195034b5e6f4b59c83443e96966ba3e818c",
      "title": "docs: Updated README.md for better usage clarity",
      "updated_at": "2021-01-27T14:03:32Z",
      "url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/52",
      "user": {
        "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
        "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
        "followers_url": "https://api.github.com/users/fuxingloh/followers",
        "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
        "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/fuxingloh",
        "id": 4266087,
        "login": "fuxingloh",
        "node_id": "MDQ6VXNlcjQyNjYwODc=",
        "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
        "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
        "repos_url": "https://api.github.com/users/fuxingloh/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/fuxingloh"
      }
    },
    "repository": {
      "archive_url": "https://api.github.com/repos/fuxingloh/multi-labeler/{archive_format}{/ref}",
      "archived": false,
      "assignees_url": "https://api.github.com/repos/fuxingloh/multi-labeler/assignees{/user}",
      "blobs_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/blobs{/sha}",
      "branches_url": "https://api.github.com/repos/fuxingloh/multi-labeler/branches{/branch}",
      "clone_url": "https://github.com/fuxingloh/multi-labeler.git",
      "collaborators_url": "https://api.github.com/repos/fuxingloh/multi-labeler/collaborators{/collaborator}",
      "comments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/comments{/number}",
      "commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/commits{/sha}",
      "compare_url": "https://api.github.com/repos/fuxingloh/multi-labeler/compare/{base}...{head}",
      "contents_url": "https://api.github.com/repos/fuxingloh/multi-labeler/contents/{+path}",
      "contributors_url": "https://api.github.com/repos/fuxingloh/multi-labeler/contributors",
      "created_at": "2021-01-13T09:32:38Z",
      "default_branch": "main",
      "deployments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/deployments",
      "description": "Multi labeler for title, body, comments, commit messages, branch, author or files with automated status checks.",
      "disabled": false,
      "downloads_url": "https://api.github.com/repos/fuxingloh/multi-labeler/downloads",
      "events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/events",
      "fork": false,
      "forks": 0,
      "forks_count": 0,
      "forks_url": "https://api.github.com/repos/fuxingloh/multi-labeler/forks",
      "full_name": "fuxingloh/multi-labeler",
      "git_commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/commits{/sha}",
      "git_refs_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/refs{/sha}",
      "git_tags_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/tags{/sha}",
      "git_url": "git://github.com/fuxingloh/multi-labeler.git",
      "has_downloads": true,
      "has_issues": true,
      "has_pages": false,
      "has_projects": true,
      "has_wiki": true,
      "homepage": "",
      "hooks_url": "https://api.github.com/repos/fuxingloh/multi-labeler/hooks",
      "html_url": "https://github.com/fuxingloh/multi-labeler",
      "id": 329257641,
      "issue_comment_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/comments{/number}",
      "issue_events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/events{/number}",
      "issues_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues{/number}",
      "keys_url": "https://api.github.com/repos/fuxingloh/multi-labeler/keys{/key_id}",
      "labels_url": "https://api.github.com/repos/fuxingloh/multi-labeler/labels{/name}",
      "language": "TypeScript",
      "languages_url": "https://api.github.com/repos/fuxingloh/multi-labeler/languages",
      "license": {
        "key": "mit",
        "name": "MIT License",
        "node_id": "MDc6TGljZW5zZTEz",
        "spdx_id": "MIT",
        "url": "https://api.github.com/licenses/mit"
      },
      "merges_url": "https://api.github.com/repos/fuxingloh/multi-labeler/merges",
      "milestones_url": "https://api.github.com/repos/fuxingloh/multi-labeler/milestones{/number}",
      "mirror_url": null,
      "name": "multi-labeler",
      "node_id": "MDEwOlJlcG9zaXRvcnkzMjkyNTc2NDE=",
      "notifications_url": "https://api.github.com/repos/fuxingloh/multi-labeler/notifications{?since,all,participating}",
      "open_issues": 1,
      "open_issues_count": 1,
      "owner": {
        "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
        "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
        "followers_url": "https://api.github.com/users/fuxingloh/followers",
        "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
        "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/fuxingloh",
        "id": 4266087,
        "login": "fuxingloh",
        "node_id": "MDQ6VXNlcjQyNjYwODc=",
        "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
        "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
        "repos_url": "https://api.github.com/users/fuxingloh/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/fuxingloh"
      },
      "private": false,
      "pulls_url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls{/number}",
      "pushed_at": "2021-01-27T14:03:24Z",
      "releases_url": "https://api.github.com/repos/fuxingloh/multi-labeler/releases{/id}",
      "size": 1224,
      "ssh_url": "git@github.com:fuxingloh/multi-labeler.git",
      "stargazers_count": 3,
      "stargazers_url": "https://api.github.com/repos/fuxingloh/multi-labeler/stargazers",
      "statuses_url": "https://api.github.com/repos/fuxingloh/multi-labeler/statuses/{sha}",
      "subscribers_url": "https://api.github.com/repos/fuxingloh/multi-labeler/subscribers",
      "subscription_url": "https://api.github.com/repos/fuxingloh/multi-labeler/subscription",
      "svn_url": "https://github.com/fuxingloh/multi-labeler",
      "tags_url": "https://api.github.com/repos/fuxingloh/multi-labeler/tags",
      "teams_url": "https://api.github.com/repos/fuxingloh/multi-labeler/teams",
      "trees_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/trees{/sha}",
      "updated_at": "2021-01-27T08:04:31Z",
      "url": "https://api.github.com/repos/fuxingloh/multi-labeler",
      "watchers": 3,
      "watchers_count": 3
    },
    "sender": {
      "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
      "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
      "followers_url": "https://api.github.com/users/fuxingloh/followers",
      "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
      "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
      "gravatar_id": "",
      "html_url": "https://github.com/fuxingloh",
      "id": 4266087,
      "login": "fuxingloh",
      "node_id": "MDQ6VXNlcjQyNjYwODc=",
      "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
      "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
      "repos_url": "https://api.github.com/users/fuxingloh/repos",
      "site_admin": false,
      "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
      "type": "User",
      "url": "https://api.github.com/users/fuxingloh"
    }
  },
  "eventName": "pull_request",
  "sha": "d507f81235f3ee80de826563fce6d0cfabc6c6ee",
  "ref": "refs/pull/52/merge",
  "workflow": "CI",
  "action": "actionsgithub-script",
  "actor": "fuxingloh",
  "job": "uses",
  "runNumber": 261,
  "runId": 515259361
}

@codecov
Copy link

codecov bot commented Jan 27, 2021

Codecov Report

Merging #52 (99d8f19) into main (f3e20f6) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #52   +/-   ##
=======================================
  Coverage   95.09%   95.09%           
=======================================
  Files          11       11           
  Lines         204      204           
  Branches       68       68           
=======================================
  Hits          194      194           
  Partials       10       10

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 f3e20f6...99d8f19. Read the comment docs.

@fuxingloh fuxingloh merged commit 1220f15 into main Jan 27, 2021
@fuxingloh fuxingloh deleted the docs/readme branch January 27, 2021 14:04
@github-actions
Copy link

Debug Payload Information 
{
  "payload": {
    "action": "created",
    "comment": {
      "author_association": "NONE",
      "body": "# [Codecov](https://codecov.io/gh/fuxingloh/multi-labeler/pull/52?src=pr&el=h1) Report\n> Merging [#52](https://codecov.io/gh/fuxingloh/multi-labeler/pull/52?src=pr&el=desc) (99d8f19) into [main](https://codecov.io/gh/fuxingloh/multi-labeler/commit/f3e20f676a3d8ab0255e439c5c9a8d2ebcb17c25?el=desc) (f3e20f6) will **not change** coverage.\n> The diff coverage is `n/a`.\n\n[![Impacted file tree graph](https://codecov.io/gh/fuxingloh/multi-labeler/pull/52/graphs/tree.svg?width=650&height=150&src=pr&token=SOWIV1VVM1)](https://codecov.io/gh/fuxingloh/multi-labeler/pull/52?src=pr&el=tree)\n\n```diff\n@@           Coverage Diff           @@\n##             main      #52   +/-   ##\n=======================================\n  Coverage   95.09%   95.09%           \n=======================================\n  Files          11       11           \n  Lines         204      204           \n  Branches       68       68           \n=======================================\n  Hits          194      194           \n  Partials       10       10           \n```\n\n\n\n------\n\n[Continue to review full report at Codecov](https://codecov.io/gh/fuxingloh/multi-labeler/pull/52?src=pr&el=continue).\n> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)\n> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`\n> Powered by [Codecov](https://codecov.io/gh/fuxingloh/multi-labeler/pull/52?src=pr&el=footer). Last update [f3e20f6...99d8f19](https://codecov.io/gh/fuxingloh/multi-labeler/pull/52?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).\n",
      "created_at": "2021-01-27T14:04:45Z",
      "html_url": "https://github.com/fuxingloh/multi-labeler/pull/52#issuecomment-768307196",
      "id": 768307196,
      "issue_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52",
      "node_id": "MDEyOklzc3VlQ29tbWVudDc2ODMwNzE5Ng==",
      "performed_via_github_app": null,
      "updated_at": "2021-01-27T14:04:45Z",
      "url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/comments/768307196",
      "user": {
        "avatar_url": "https://avatars.githubusercontent.com/in/254?v=4",
        "events_url": "https://api.github.com/users/codecov%5Bbot%5D/events{/privacy}",
        "followers_url": "https://api.github.com/users/codecov%5Bbot%5D/followers",
        "following_url": "https://api.github.com/users/codecov%5Bbot%5D/following{/other_user}",
        "gists_url": "https://api.github.com/users/codecov%5Bbot%5D/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/apps/codecov",
        "id": 22429695,
        "login": "codecov[bot]",
        "node_id": "MDM6Qm90MjI0Mjk2OTU=",
        "organizations_url": "https://api.github.com/users/codecov%5Bbot%5D/orgs",
        "received_events_url": "https://api.github.com/users/codecov%5Bbot%5D/received_events",
        "repos_url": "https://api.github.com/users/codecov%5Bbot%5D/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/codecov%5Bbot%5D/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/codecov%5Bbot%5D/subscriptions",
        "type": "Bot",
        "url": "https://api.github.com/users/codecov%5Bbot%5D"
      }
    },
    "issue": {
      "active_lock_reason": null,
      "assignee": null,
      "assignees": [],
      "author_association": "OWNER",
      "body": "",
      "closed_at": null,
      "comments": 2,
      "comments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52/comments",
      "created_at": "2021-01-27T14:03:32Z",
      "events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52/events",
      "html_url": "https://github.com/fuxingloh/multi-labeler/pull/52",
      "id": 795128981,
      "labels": [
        {
          "color": "ededed",
          "default": false,
          "description": null,
          "id": 2691410095,
          "name": "Maintainer",
          "node_id": "MDU6TGFiZWwyNjkxNDEwMDk1",
          "url": "https://api.github.com/repos/fuxingloh/multi-labeler/labels/Maintainer"
        },
        {
          "color": "ededed",
          "default": false,
          "description": null,
          "id": 2691410096,
          "name": "Owner",
          "node_id": "MDU6TGFiZWwyNjkxNDEwMDk2",
          "url": "https://api.github.com/repos/fuxingloh/multi-labeler/labels/Owner"
        },
        {
          "color": "ededed",
          "default": false,
          "description": null,
          "id": 2658039731,
          "name": "docs",
          "node_id": "MDU6TGFiZWwyNjU4MDM5NzMx",
          "url": "https://api.github.com/repos/fuxingloh/multi-labeler/labels/docs"
        },
        {
          "color": "ededed",
          "default": false,
          "description": null,
          "id": 2659552058,
          "name": "test: s",
          "node_id": "MDU6TGFiZWwyNjU5NTUyMDU4",
          "url": "https://api.github.com/repos/fuxingloh/multi-labeler/labels/test:%20s"
        }
      ],
      "labels_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52/labels{/name}",
      "locked": false,
      "milestone": null,
      "node_id": "MDExOlB1bGxSZXF1ZXN0NTYyNTI4ODAx",
      "number": 52,
      "performed_via_github_app": null,
      "pull_request": {
        "diff_url": "https://github.com/fuxingloh/multi-labeler/pull/52.diff",
        "html_url": "https://github.com/fuxingloh/multi-labeler/pull/52",
        "patch_url": "https://github.com/fuxingloh/multi-labeler/pull/52.patch",
        "url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls/52"
      },
      "repository_url": "https://api.github.com/repos/fuxingloh/multi-labeler",
      "state": "open",
      "title": "docs: Updated README.md for better usage clarity",
      "updated_at": "2021-01-27T14:04:45Z",
      "url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/52",
      "user": {
        "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
        "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
        "followers_url": "https://api.github.com/users/fuxingloh/followers",
        "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
        "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/fuxingloh",
        "id": 4266087,
        "login": "fuxingloh",
        "node_id": "MDQ6VXNlcjQyNjYwODc=",
        "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
        "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
        "repos_url": "https://api.github.com/users/fuxingloh/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/fuxingloh"
      }
    },
    "repository": {
      "archive_url": "https://api.github.com/repos/fuxingloh/multi-labeler/{archive_format}{/ref}",
      "archived": false,
      "assignees_url": "https://api.github.com/repos/fuxingloh/multi-labeler/assignees{/user}",
      "blobs_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/blobs{/sha}",
      "branches_url": "https://api.github.com/repos/fuxingloh/multi-labeler/branches{/branch}",
      "clone_url": "https://github.com/fuxingloh/multi-labeler.git",
      "collaborators_url": "https://api.github.com/repos/fuxingloh/multi-labeler/collaborators{/collaborator}",
      "comments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/comments{/number}",
      "commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/commits{/sha}",
      "compare_url": "https://api.github.com/repos/fuxingloh/multi-labeler/compare/{base}...{head}",
      "contents_url": "https://api.github.com/repos/fuxingloh/multi-labeler/contents/{+path}",
      "contributors_url": "https://api.github.com/repos/fuxingloh/multi-labeler/contributors",
      "created_at": "2021-01-13T09:32:38Z",
      "default_branch": "main",
      "deployments_url": "https://api.github.com/repos/fuxingloh/multi-labeler/deployments",
      "description": "Multi labeler for title, body, comments, commit messages, branch, author or files with automated status checks.",
      "disabled": false,
      "downloads_url": "https://api.github.com/repos/fuxingloh/multi-labeler/downloads",
      "events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/events",
      "fork": false,
      "forks": 0,
      "forks_count": 0,
      "forks_url": "https://api.github.com/repos/fuxingloh/multi-labeler/forks",
      "full_name": "fuxingloh/multi-labeler",
      "git_commits_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/commits{/sha}",
      "git_refs_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/refs{/sha}",
      "git_tags_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/tags{/sha}",
      "git_url": "git://github.com/fuxingloh/multi-labeler.git",
      "has_downloads": true,
      "has_issues": true,
      "has_pages": false,
      "has_projects": true,
      "has_wiki": true,
      "homepage": "",
      "hooks_url": "https://api.github.com/repos/fuxingloh/multi-labeler/hooks",
      "html_url": "https://github.com/fuxingloh/multi-labeler",
      "id": 329257641,
      "issue_comment_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/comments{/number}",
      "issue_events_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues/events{/number}",
      "issues_url": "https://api.github.com/repos/fuxingloh/multi-labeler/issues{/number}",
      "keys_url": "https://api.github.com/repos/fuxingloh/multi-labeler/keys{/key_id}",
      "labels_url": "https://api.github.com/repos/fuxingloh/multi-labeler/labels{/name}",
      "language": "TypeScript",
      "languages_url": "https://api.github.com/repos/fuxingloh/multi-labeler/languages",
      "license": {
        "key": "mit",
        "name": "MIT License",
        "node_id": "MDc6TGljZW5zZTEz",
        "spdx_id": "MIT",
        "url": "https://api.github.com/licenses/mit"
      },
      "merges_url": "https://api.github.com/repos/fuxingloh/multi-labeler/merges",
      "milestones_url": "https://api.github.com/repos/fuxingloh/multi-labeler/milestones{/number}",
      "mirror_url": null,
      "name": "multi-labeler",
      "node_id": "MDEwOlJlcG9zaXRvcnkzMjkyNTc2NDE=",
      "notifications_url": "https://api.github.com/repos/fuxingloh/multi-labeler/notifications{?since,all,participating}",
      "open_issues": 1,
      "open_issues_count": 1,
      "owner": {
        "avatar_url": "https://avatars.githubusercontent.com/u/4266087?v=4",
        "events_url": "https://api.github.com/users/fuxingloh/events{/privacy}",
        "followers_url": "https://api.github.com/users/fuxingloh/followers",
        "following_url": "https://api.github.com/users/fuxingloh/following{/other_user}",
        "gists_url": "https://api.github.com/users/fuxingloh/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/fuxingloh",
        "id": 4266087,
        "login": "fuxingloh",
        "node_id": "MDQ6VXNlcjQyNjYwODc=",
        "organizations_url": "https://api.github.com/users/fuxingloh/orgs",
        "received_events_url": "https://api.github.com/users/fuxingloh/received_events",
        "repos_url": "https://api.github.com/users/fuxingloh/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/fuxingloh/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/fuxingloh/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/fuxingloh"
      },
      "private": false,
      "pulls_url": "https://api.github.com/repos/fuxingloh/multi-labeler/pulls{/number}",
      "pushed_at": "2021-01-27T14:03:33Z",
      "releases_url": "https://api.github.com/repos/fuxingloh/multi-labeler/releases{/id}",
      "size": 1224,
      "ssh_url": "git@github.com:fuxingloh/multi-labeler.git",
      "stargazers_count": 3,
      "stargazers_url": "https://api.github.com/repos/fuxingloh/multi-labeler/stargazers",
      "statuses_url": "https://api.github.com/repos/fuxingloh/multi-labeler/statuses/{sha}",
      "subscribers_url": "https://api.github.com/repos/fuxingloh/multi-labeler/subscribers",
      "subscription_url": "https://api.github.com/repos/fuxingloh/multi-labeler/subscription",
      "svn_url": "https://github.com/fuxingloh/multi-labeler",
      "tags_url": "https://api.github.com/repos/fuxingloh/multi-labeler/tags",
      "teams_url": "https://api.github.com/repos/fuxingloh/multi-labeler/teams",
      "trees_url": "https://api.github.com/repos/fuxingloh/multi-labeler/git/trees{/sha}",
      "updated_at": "2021-01-27T08:04:31Z",
      "url": "https://api.github.com/repos/fuxingloh/multi-labeler",
      "watchers": 3,
      "watchers_count": 3
    },
    "sender": {
      "avatar_url": "https://avatars.githubusercontent.com/in/254?v=4",
      "events_url": "https://api.github.com/users/codecov%5Bbot%5D/events{/privacy}",
      "followers_url": "https://api.github.com/users/codecov%5Bbot%5D/followers",
      "following_url": "https://api.github.com/users/codecov%5Bbot%5D/following{/other_user}",
      "gists_url": "https://api.github.com/users/codecov%5Bbot%5D/gists{/gist_id}",
      "gravatar_id": "",
      "html_url": "https://github.com/apps/codecov",
      "id": 22429695,
      "login": "codecov[bot]",
      "node_id": "MDM6Qm90MjI0Mjk2OTU=",
      "organizations_url": "https://api.github.com/users/codecov%5Bbot%5D/orgs",
      "received_events_url": "https://api.github.com/users/codecov%5Bbot%5D/received_events",
      "repos_url": "https://api.github.com/users/codecov%5Bbot%5D/repos",
      "site_admin": false,
      "starred_url": "https://api.github.com/users/codecov%5Bbot%5D/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/codecov%5Bbot%5D/subscriptions",
      "type": "Bot",
      "url": "https://api.github.com/users/codecov%5Bbot%5D"
    }
  },
  "eventName": "issue_comment",
  "sha": "f3e20f676a3d8ab0255e439c5c9a8d2ebcb17c25",
  "ref": "refs/heads/main",
  "workflow": "CI",
  "action": "actionsgithub-script",
  "actor": "codecov[bot]",
  "job": "uses",
  "runNumber": 262,
  "runId": 515262425
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs Maintainer Owner test: s
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@fuxingloh