{"id":21232857,"url":"https://github.com/offensive-vk/auto-label","last_synced_at":"2026-05-20T14:18:06.557Z","repository":{"id":257412493,"uuid":"855528467","full_name":"offensive-vk/auto-label","owner":"offensive-vk","description":"Github Action to Automatically Apply Labels on Both PRs and Issues.","archived":false,"fork":false,"pushed_at":"2025-06-28T16:23:21.000Z","size":3650,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-04T20:50:12.440Z","etag":null,"topics":["actions","automated","github-action","label"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/auto-label-stuff","language":"TypeScript","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/offensive-vk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2024-09-11T02:37:38.000Z","updated_at":"2025-06-28T16:23:19.000Z","dependencies_parsed_at":"2024-09-16T15:52:59.977Z","dependency_job_id":"1bab6cab-d4f4-458d-8a90-ded9d1031835","html_url":"https://github.com/offensive-vk/auto-label","commit_stats":null,"previous_names":["offensive-vk/auto-label"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/offensive-vk/auto-label","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-label","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-label/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-label/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-label/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/offensive-vk","download_url":"https://codeload.github.com/offensive-vk/auto-label/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-label/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265798523,"owners_count":23829957,"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":["actions","automated","github-action","label"],"created_at":"2024-11-20T23:54:56.913Z","updated_at":"2026-05-20T14:18:01.534Z","avatar_url":"https://github.com/offensive-vk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Auto-Label\n\nThe **auto-label** GitHub Action simplifies the process of adding labels to issues and pull requests in your repository. Powered by the GitHub Octokit API, this Action can match specific keywords or file patterns to apply labels automatically.\n\nFor a complete example, have a look at our [workflow](.github/workflows/test.yml). 🙌\n\n## Features\n\n- **Automatic Labeling**: Apply labels to issues and pull requests based on custom rules.\n- **Keyword Matching**: Match specific keywords in issues to apply relevant labels.\n- **File Pattern Matching**: Automatically label pull requests based on modified file patterns.\n- **Optional Label Creation**: Create missing labels automatically with suitable descriptions.\n- **Both PR and Issues**: Works on both issues and pull request using separate files.\n\n---\n\n## Usage Examples\n\n### Apply Labels on Issues\n\n```yaml\nsteps:\n  - name: Apply Labels on Issues\n    if: github.event_name == 'issues'\n    uses: offensive-vk/auto-label@v8\n    with:\n      create-labels: true # Optional, defaults to true\n      auth-token: ${{ github.token }} # Optional, defaults to ${{ secrets.GITHUB_TOKEN }}\n      issue-config: .github/issues.yml # Required, path to the issue configuration file.\n```\n\n### Apply Labels on Pull Requests\n\n```yaml\nsteps:\n  - name: Apply Labels on Pull Requests\n    if: github.event_name == 'pull_request'\n    uses: offensive-vk/auto-label@v8\n    with:\n      create-labels: true # Optional, defaults to true\n      auth-token: ${{ github.token }} # Optional, defaults to ${{ secrets.GITHUB_TOKEN }}\n      pr-config: .github/pr.yml # Required, path to the pull request configuration file.\n```\n\n---\n\n## Input Configuration\n\nConfigure inputs through the `with:` section of the Action. Below is the list of available options:\n\n| Input          | Default Value                 | Description |\n|----------------|-------------------------------|-------------|\n| `auth-token` | `${{ github.token }}` | The GitHub token for authenticating requests. You can use `${{ secrets.GITHUB_TOKEN }}` or a personal access token (PAT) stored in your secrets. |\n| `issue-config` | `.github/issues.yml`          | Path to the YAML configuration file for labeling issues. |\n| `pr-config`    | `.github/pr.yml`              | Path to the YAML configuration file for labeling pull requests. |\n| `create-labels`| `true`                        | Whether to create missing labels in the repository. |\n| `debug`        | `false`                       | Whether to enable debug mode or not. |\n| `number`        | `0`                       | Valid only at workflow_dispatch event. |\n\n---\n\n## Configuration Files\n\n### Issue Configuration\n\nDefine rules to apply labels on issues based on keywords. Below is an example:\n\n```yaml\n# .github/issues.yml\nbug:\n  match:\n    - \"error\"\n    - \"fail\"\n    - \"bug\"\n    - \"crash\"\n  description: \"Indicates a bug or error in the system.\"\n\nfeat:\n  match:\n    - \"feature\"\n    - \"enhancement\"\n    - \"improvement\"\n  description: \"Suggests a new feature or improvement.\"\n\ndocumentation:\n  match:\n    - \"doc\"\n    - \"documentation\"\n    - \"readme\"\n  description: \"Related to documentation updates or changes.\"\n```\n\n### Pull Request Configuration\n\nDefine rules to apply labels on pull requests based on file patterns. Below is an example:\n\n```yaml\n# .github/pr.yml\narea/release:\n  match:\n    - 'release/**/*'\n    - 'release_assets/**/*'\n    - '**/*.assets'\n  description: \"Related to releases.\"\n\narea/build:\n  match:\n    - 'build/**/*'\n    - 'resources/**'\n  description: \"Related to build\"\n\narea/ci-cd:\n  match:\n    - '**/*.yml'\n    - '**/*.yaml'\n  description: \"Related to ci/cd\"\n\n```\n\n## How It Works\n\n1. The Action triggers based on GitHub events (`issues` or `pull_request`).\n2. Matches keywords (for issues) or file patterns (for pull requests) against the configuration file.\n3. Applies labels to issues or pull requests that match the criteria.\n4. Optionally creates missing labels in the repository.\n5. Works both on issue and pull requests.\n\n## License\n\nThis repository is licensed under the [MIT License](https://github.com/offensive-vk/auto-issue?tab=MIT-1-ov-file).\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003ci\u003e\u0026copy; \u003ca href=\"https://github.com/offensive-vk/\"\u003eVedansh \u003c/a\u003e 2020 - Present\u003c/i\u003e\u003cbr\u003e\n  \u003ci\u003eLicensed under \u003ca href=\"https://github.com/offensive-vk/auto-label?tab=MIT-1-ov-file\"\u003eMIT\u003c/a\u003e\u003c/i\u003e\u003cbr\u003e\n  \u003ca href=\"https://github.com/TheHamsterBot\"\u003e\u003cimg src=\"https://i.ibb.co/4KtpYxb/octocat-clean-mini.png\" alt=\"hamster\"/\u003e\u003c/a\u003e\u003cbr\u003e\n  \u003csup\u003eThanks for visiting :)\u003c/sup\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffensive-vk%2Fauto-label","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foffensive-vk%2Fauto-label","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffensive-vk%2Fauto-label/lists"}