{"id":15632750,"url":"https://github.com/azu/github-label-setup","last_synced_at":"2025-04-09T07:08:37.780Z","repository":{"id":45895554,"uuid":"91394386","full_name":"azu/github-label-setup","owner":"azu","description":"📦 Setup GitHub label without configuration.","archived":false,"fork":false,"pushed_at":"2023-01-09T02:02:16.000Z","size":287,"stargazers_count":166,"open_issues_count":1,"forks_count":18,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T05:08:38.525Z","etag":null,"topics":["github","label","repository","setup"],"latest_commit_sha":null,"homepage":"","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/azu.png","metadata":{"funding":{"github":"azu"},"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}},"created_at":"2017-05-15T23:46:25.000Z","updated_at":"2024-12-19T15:27:41.000Z","dependencies_parsed_at":"2023-02-08T08:15:55.985Z","dependency_job_id":null,"html_url":"https://github.com/azu/github-label-setup","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azu%2Fgithub-label-setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azu%2Fgithub-label-setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azu%2Fgithub-label-setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azu%2Fgithub-label-setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/azu","download_url":"https://codeload.github.com/azu/github-label-setup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247994121,"owners_count":21030050,"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","label","repository","setup"],"created_at":"2024-10-03T10:45:11.079Z","updated_at":"2025-04-09T07:08:37.755Z","avatar_url":"https://github.com/azu.png","language":"JavaScript","funding_links":["https://github.com/sponsors/azu"],"categories":[],"sub_categories":[],"readme":"# @azu/github-label-setup\n\nOpinionated GitHub label setup tool.\n\n[![demo](./img/demo.png)](https://github.com/azu/github-label-setup/issues/1)\n\n- Create starter GitHub labels\n- Migrate existing labels\n- No configuration - It is opinionated\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n    npm install --global @azu/github-label-setup\n\n## Usage\n\nThis tool works without any configuration.\n\n    Usage\n      $ github-label-setup --token xxx\n\n    Options\n\n      -h, --help                  [Boolean] output usage information\n      -l, --labels \u003cpath\u003e         [Path:String] the path to look for the label configuration in. Default: labels.json\n      --token \u003ctoken\u003e             [String] a GitHub access token (also settable with a GITHUB_TOKEN or GITHUB_ACCESS_TOKEN environment variable)\n      -d, --dry-run               [Boolean] calculate the required label changes but do not apply them\n      -A, --allow-added-labels    [Boolean] allow additional labels in the repo, and don't delete them\n      \n    GitHub Release Options\n      \n      --addReleaseYml             [Boolean] add a .github/release.yml file\n      --addReleaseYmlOutputPath   [Path:String] the path to write the .github/release.yml file to. Default: .github/release.yml\n\n    Examples\n        # Overwrite labels in the current repository\n        $ github-label-setup --token \"$GITHUB_TOKEN\"\n        # Add labels to the current repository\n        $ github-label-setup --token \"$GITHUB_TOKEN\" --allow-added-labels\n        # Add .github/release.yml to integrate with GitHub Releases\n        $ github-label-setup --addReleaseYml\n\n\nYou will need to get a GitHub Personal Accesses token to update labels of your repository.\nYou need to generate [GitHub Personal Accesses token](https://github.com/settings/tokens/new?scopes=repo) with `\"repo\"` scope.\n\n- Generation Link: \u003chttps://github.com/settings/tokens/new?scopes=repo\u003e\n\nThis tool is a wrapper of `github-label-sync`.\n\n- [Financial-Times/github-label-sync: Synchronise your GitHub labels with as few destructive operations as possible](https://github.com/Financial-Times/github-label-sync \"Financial-Times/github-label-sync: Synchronise your GitHub labels with as few destructive operations as possible\")\n\n### Npm packages for labels\n\nlabels can be set `require`able path like npm packages.\n\n    $ github-label-setup --token xxx --labels @owner/github-label-presets\n\nSee [Label JSON](https://github.com/Financial-Times/github-label-sync#label-json \"Label JSON\") format.\n\n## Default Labels\n\nThese are opinionated labels.\n\n[![demo](./img/demo.png)](https://github.com/azu/github-label-setup/issues/1)\n\n- ![#ededed](https://placehold.co/15x15/ededed/ededed.png) duplicate - This issue or Pull Request already exists\n- ![#e99695](https://placehold.co/15x15/e99695/e99695.png) help wanted - Extra attention is needed\n- ![#7057ff](https://placehold.co/15x15/7057ff/7057ff.png) good first issue - Good for newcomers\n- ![#ee0701](https://placehold.co/15x15/ee0701/ee0701.png) Priority: Critical\n- ![#d93f0b](https://placehold.co/15x15/d93f0b/d93f0b.png) Priority: High\n- ![#fbca04](https://placehold.co/15x15/fbca04/fbca04.png) Priority: Medium\n- ![#0e8a16](https://placehold.co/15x15/0e8a16/0e8a16.png) Priority: Low\n- ![#000000](https://placehold.co/15x15/000000/000000.png) Status: Abandoned - The issue or Pull Request is wontfix\n- ![#ee0701](https://placehold.co/15x15/ee0701/ee0701.png) Status: Blocked - Progress on the issue is Blocked\n- ![#cccccc](https://placehold.co/15x15/cccccc/cccccc.png) Status: In Progress - Work in Progress\n- ![#d4c5f9](https://placehold.co/15x15/d4c5f9/d4c5f9.png) Status: Proposal - Request for comments\n- ![#2E7733](https://placehold.co/15x15/2E7733/2E7733.png) Status: PR Welcome - Welcome to Pull Request\n- ![#fbca04](https://placehold.co/15x15/fbca04/fbca04.png) Status: Review Needed - Request for review comments\n- ![#F9C90A](https://placehold.co/15x15/F9C90A/F9C90A.png) Status: Need More Info - Lacks enough info to make progress\n- ![#b60205](https://placehold.co/15x15/b60205/b60205.png) Type: Breaking Change - Includes breaking changes\n- ![#ee0701](https://placehold.co/15x15/ee0701/ee0701.png) Type: Bug - Bug or Bug fixes\n- ![#0e8a16](https://placehold.co/15x15/0e8a16/0e8a16.png) Type: Documentation - Documentation only changes\n- ![#1d76db](https://placehold.co/15x15/1d76db/1d76db.png) Type: Feature - New Feature\n- ![#fbca04](https://placehold.co/15x15/fbca04/fbca04.png) Type: Refactoring - A code change that neither fixes a bug nor adds a feature\n- ![#257759](https://placehold.co/15x15/257759/257759.png) Type: Testing - Adding missing tests or correcting existing tests\n- ![#abd406](https://placehold.co/15x15/abd406/abd406.png) Type: Maintenance - Repository Maintenance\n- ![#ffd412](https://placehold.co/15x15/ffd412/ffd412.png) Type: CI - Changes to CI configuration files and scripts\n- ![#cc317c](https://placehold.co/15x15/cc317c/cc317c.png) Type: Question - Further information is requested\n- ![#ee0701](https://placehold.co/15x15/ee0701/ee0701.png) Type: Security - Vulnerability disclosure or Fixing security issue\n- ![#0366d6](https://placehold.co/15x15/0366d6/0366d6.png) Type: Dependencies - Dependency issues or Changes to dependency files\n- ![#0366d6](https://placehold.co/15x15/BFD4F2/BFD4F2.png) Type: Meta - Related to repository itself (This will not be includes in Release Note)\n- ![#0366d6](https://placehold.co/15x15/5319E7/5319E7.png) Type: Release - Related to release process (This will not be includes in Release Note)\n\n## Integration with GitHub Releases\n\nGitHub Releases support automatically generate release notes using labels.\n`--addReleaseYml` option will add `.github/release.yml` file to your repository.\n\n```bash\n# Add .github/release.yml to integrate with GitHub Releases\n$ github-label-setup --addReleaseYml\n```\n\nFor more details, see GitHub Releases document.\n\n- [Configuring automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes)\n\n## Related\n\n- [Conventional Commits](https://conventionalcommits.org/ \"Conventional Commits\")\n- [yoshuawuyts/github-standard-labels: Create a standard set of issue labels for a GitHub project](https://github.com/yoshuawuyts/github-standard-labels \"yoshuawuyts/github-standard-labels: Create a standard set of issue labels for a GitHub project\")\n- [Financial-Times/github-label-sync: Synchronise your GitHub labels with as few destructive operations as possible](https://github.com/Financial-Times/github-label-sync \"Financial-Times/github-label-sync: Synchronise your GitHub labels with as few destructive operations as possible\")\n- [MunGell/awesome-for-beginners: A list of awesome beginners-friendly projects.](https://github.com/MunGell/awesome-for-beginners \"MunGell/awesome-for-beginners: A list of awesome beginners-friendly projects.\")\n- [himynameisdave/git-labelmaker: Manage your GitHub labels from the command line!](https://github.com/himynameisdave/git-labelmaker \"himynameisdave/git-labelmaker: Manage your GitHub labels from the command line!\")\n- [Sane GitHub Labels – Dave Lunny – Medium](https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63 \"Sane GitHub Labels – Dave Lunny – Medium\")\n\n## Changelog\n\nSee [Releases page](https://github.com/azu/github-label-setup/releases).\n\n## Running tests\n\nInstall devDependencies and Run `npm test`:\n\n    npm i -d \u0026\u0026 npm test\n\n## Contributing\n\nPull requests and stars are always welcome.\n\nFor bugs and feature requests, [please create an issue](https://github.com/azu/github-label-setup/issues).\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## Author\n\n- [github/azu](https://github.com/azu)\n- [twitter/azu_re](https://twitter.com/azu_re)\n\n## License\n\nMIT © azu\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazu%2Fgithub-label-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazu%2Fgithub-label-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazu%2Fgithub-label-setup/lists"}