{"id":16252471,"url":"https://github.com/remarkablemark/conventional-release-setup","last_synced_at":"2025-03-19T20:31:20.851Z","repository":{"id":38328490,"uuid":"241026160","full_name":"remarkablemark/conventional-release-setup","owner":"remarkablemark","description":":rocket: Sets up package for committing and releasing with conventional commits.","archived":false,"fork":false,"pushed_at":"2024-10-29T08:50:05.000Z","size":1748,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-29T10:00:22.920Z","etag":null,"topics":["cli","commitlint","conventional-commits","executable","husky","npm","package","standard-version"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/conventional-release-setup","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/remarkablemark.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["remarkablemark"],"patreon":"remarkablemark","open_collective":null,"ko_fi":"remarkablemark","tidelift":null,"community_bridge":null,"liberapay":"remarkablemark","issuehunt":null,"otechie":null,"custom":["https://b.remarkabl.org/teespring"]}},"created_at":"2020-02-17T05:22:19.000Z","updated_at":"2024-10-29T08:50:07.000Z","dependencies_parsed_at":"2022-09-08T17:01:19.173Z","dependency_job_id":"e285f4b1-3b6c-450c-b635-9534dcc65589","html_url":"https://github.com/remarkablemark/conventional-release-setup","commit_stats":{"total_commits":239,"total_committers":4,"mean_commits":59.75,"dds":"0.43096234309623427","last_synced_commit":"961a715c4cdb4b2b411685247a9ab8418417d1a4"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkablemark%2Fconventional-release-setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkablemark%2Fconventional-release-setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkablemark%2Fconventional-release-setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkablemark%2Fconventional-release-setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remarkablemark","download_url":"https://codeload.github.com/remarkablemark/conventional-release-setup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244018895,"owners_count":20384654,"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":["cli","commitlint","conventional-commits","executable","husky","npm","package","standard-version"],"created_at":"2024-10-10T15:13:50.371Z","updated_at":"2025-03-19T20:31:19.790Z","avatar_url":"https://github.com/remarkablemark.png","language":"JavaScript","funding_links":["https://github.com/sponsors/remarkablemark","https://patreon.com/remarkablemark","https://ko-fi.com/remarkablemark","https://liberapay.com/remarkablemark","https://b.remarkabl.org/teespring"],"categories":[],"sub_categories":[],"readme":"# conventional-release-setup\n\n[![NPM](https://nodei.co/npm/conventional-release-setup.png)](https://nodei.co/npm/conventional-release-setup/)\n\n[![NPM version](https://img.shields.io/npm/v/conventional-release-setup.svg)](https://www.npmjs.com/package/conventional-release-setup)\n[![build](https://github.com/remarkablemark/conventional-release-setup/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablemark/conventional-release-setup/actions/workflows/build.yml)\n[![codecov](https://codecov.io/gh/remarkablemark/conventional-release-setup/graph/badge.svg?token=9U6TQRNAZ9)](https://codecov.io/gh/remarkablemark/conventional-release-setup)\n\nSets up an npm project for committing and releasing with [Conventional Commits](https://www.conventionalcommits.org/):\n\n```sh\nnpx conventional-release-setup@latest\n```\n\n## Usage\n\nRun the CLI:\n\n```sh\nnpx conventional-release-setup\n```\n\nOr install the CLI globally and run:\n\n```sh\nnpm install --global conventional-release-setup\nconventional-release-setup\n```\n\nIf you want to release with [standard-version](https://www.npmjs.com/package/standard-version), then use v1:\n\n```sh\nnpx conventional-release-setup@1\n```\n\n## What It Does\n\nThe script:\n\n- updates `package.json`:\n  - `version`\n    - appends `-alpha`\n  - `scripts`\n    - prepends `release` with `husky install`\n- installs devDependencies:\n  - [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli) - lints commit messages\n  - [@commitlint/config-conventional](https://www.npmjs.com/package/@commitlint/config-conventional) - config with [conventional commits](https://conventionalcommits.org/) rules\n  - [husky](https://www.npmjs.com/package/husky) - sets up git hooks\n- copies the configs:\n  - [.github/workflows/release-please.yml](https://github.com/googleapis/release-please-action) - generates changelog, bumps version, and creates git commit, tag, and release\n  - [.commitlintrc.json](https://github.com/remarkablemark/conventional-release-setup/blob/master/files/.commitlintrc.json)\n- adds husky hook `commit-msg`\n\n## Release\n\nRelease is automated with [Release Please](https://github.com/googleapis/release-please-action).\n\n## License\n\n[MIT](https://github.com/remarkablemark/conventional-release-setup/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkablemark%2Fconventional-release-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremarkablemark%2Fconventional-release-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkablemark%2Fconventional-release-setup/lists"}