{"id":20915828,"url":"https://github.com/dessant/support-requests","last_synced_at":"2025-04-08T04:19:16.742Z","repository":{"id":51869160,"uuid":"109355055","full_name":"dessant/support-requests","owner":"dessant","description":"GitHub Action that comments on and closes issues labeled as support requests","archived":false,"fork":false,"pushed_at":"2023-11-15T00:32:22.000Z","size":1944,"stargazers_count":35,"open_issues_count":0,"forks_count":13,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-29T12:58:49.353Z","etag":null,"topics":["github-actions","issues","support"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/support-requests","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dessant.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"dessant","patreon":"dessant","custom":["https://armin.dev/go/paypal","https://armin.dev/go/bitcoin"]}},"created_at":"2017-11-03T05:17:07.000Z","updated_at":"2024-08-11T13:54:51.000Z","dependencies_parsed_at":"2024-06-18T13:47:43.940Z","dependency_job_id":"b3ba2aa8-adb7-4408-b17f-527194a555c2","html_url":"https://github.com/dessant/support-requests","commit_stats":{"total_commits":98,"total_committers":4,"mean_commits":24.5,"dds":0.326530612244898,"last_synced_commit":"b1303caf4438e66dea1130aa4c30189dc28e690d"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dessant%2Fsupport-requests","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dessant%2Fsupport-requests/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dessant%2Fsupport-requests/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dessant%2Fsupport-requests/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dessant","download_url":"https://codeload.github.com/dessant/support-requests/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247773726,"owners_count":20993639,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","issues","support"],"created_at":"2024-11-18T16:18:35.812Z","updated_at":"2025-04-08T04:19:16.724Z","avatar_url":"https://github.com/dessant.png","language":"JavaScript","funding_links":["https://github.com/sponsors/dessant","https://patreon.com/dessant","https://armin.dev/go/paypal","https://armin.dev/go/bitcoin"],"categories":[],"sub_categories":[],"readme":"# Support Requests\n\nSupport Requests is a GitHub Action that comments on\nand closes issues labeled as support requests.\n\n![](assets/screenshot.png)\n\n## Supporting the Project\n\nThe continued development of Support Requests is made possible\nthanks to the support of awesome backers. If you'd like to join them,\nplease consider contributing with\n[Patreon](https://armin.dev/go/patreon?pr=support-requests\u0026src=repo),\n[PayPal](https://armin.dev/go/paypal?pr=support-requests\u0026src=repo) or\n[Bitcoin](https://armin.dev/go/bitcoin?pr=support-requests\u0026src=repo).\n\n## Description\n\nSupport Requests is a specialized version of\n[Label Actions](https://github.com/dessant/label-actions),\nand it can perform the following actions when an issue\nis labeled, unlabeled or reopened:\n\n- The support label is added: leave a comment, close and lock the issue\n- The support label is removed: reopen and unlock the issue\n- The issue is reopened: remove the support label, unlock the issue\n\n## Usage\n\nCreate the `support-requests.yml` workflow file in the `.github/workflows`\ndirectory, use one of the [example workflows](#examples) to get started.\n\n### Inputs\n\nThe action can be configured using [input parameters](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswith).\n\n\u003c!-- prettier-ignore --\u003e\n- **`github-token`**\n  - GitHub access token, value must be `${{ github.token }}` or an encrypted\n    secret that contains a [personal access token](#using-a-personal-access-token)\n  - Optional, defaults to `${{ github.token }}`\n- **`support-label`**\n  - Label used to mark issues as support requests\n  - Optional, defaults to `support`\n- **`issue-comment`**\n  - Comment to post on issues marked as support requests,\n    `{issue-author}` is an optional placeholder\n  - Optional, defaults to `:wave: @{issue-author}, we use the issue tracker\n    exclusively for bug reports and feature requests. However, this issue\n    appears to be a support request. Please use our support channels\n    to get help with the project.`\n- **`close-issue`**\n  - Close issues marked as support requests,\n    value must be either `true` or `false`\n  - Optional, defaults to `true`\n- **`issue-close-reason`**\n  - Reason for closing issues, value must be\n    either `completed` or `not planned`\n  - Optional, defaults to `not planned`\n- **`lock-issue`**\n  - Lock issues marked as support requests,\n    value must be either `true` or `false`\n  - Optional, defaults to `false`\n- **`issue-lock-reason`**\n  - Reason for locking issues, value must be one\n    of `resolved`, `off-topic`, `too heated` or `spam`\n  - Optional, defaults to `off-topic`\n\n## Examples\n\nThe following workflow will comment on and close issues\nmarked as support requests.\n\n\u003c!-- prettier-ignore --\u003e\n```yaml\nname: 'Support Requests'\n\non:\n  issues:\n    types: [labeled, unlabeled, reopened]\n\npermissions:\n  issues: write\n\njobs:\n  action:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: dessant/support-requests@v4\n```\n\n### Available input parameters\n\nThis workflow declares all the available input parameters of the action\nand their default values. Any of the parameters can be omitted.\n\n\u003c!-- prettier-ignore --\u003e\n```yaml\nname: 'Support Requests'\n\non:\n  issues:\n    types: [labeled, unlabeled, reopened]\n\npermissions:\n  issues: write\n\njobs:\n  action:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: dessant/support-requests@v4\n        with:\n          github-token: ${{ github.token }}\n          support-label: 'support'\n          issue-comment: \u003e\n            :wave: @{issue-author}, we use the issue tracker exclusively\n            for bug reports and feature requests. However, this issue appears\n            to be a support request. Please use our support channels\n            to get help with the project.\n          close-issue: true\n          issue-close-reason: 'not planned'\n          lock-issue: false\n          issue-lock-reason: 'off-topic'\n```\n\n### Using a personal access token\n\nThe action uses an installation access token by default to interact with GitHub.\nYou may also authenticate with a personal access token to perform actions\nas a GitHub user instead of the `github-actions` app.\n\nCreate a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)\nwith the `repo` or `public_repo` scopes enabled, and add the token as an\n[encrypted secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)\nfor the repository or organization, then provide the action with the secret\nusing the `github-token` input parameter.\n\n\u003c!-- prettier-ignore --\u003e\n```yaml\n    steps:\n      - uses: dessant/support-requests@v4\n        with:\n          github-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}\n```\n\n## License\n\nCopyright (c) 2017-2023 Armin Sebastian\n\nThis software is released under the terms of the MIT License.\nSee the [LICENSE](LICENSE) file for further information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdessant%2Fsupport-requests","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdessant%2Fsupport-requests","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdessant%2Fsupport-requests/lists"}