{"id":20336746,"url":"https://github.com/abelflopes/semantic-release-config-conventional","last_synced_at":"2026-04-17T05:02:25.797Z","repository":{"id":196970175,"uuid":"697685866","full_name":"abelflopes/semantic-release-config-conventional","owner":"abelflopes","description":"A shareable semantic-release config to publish npm packages with GitHub using conventional commits standard.","archived":false,"fork":false,"pushed_at":"2023-09-28T12:28:43.000Z","size":312,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-04T18:55:30.033Z","etag":null,"topics":["automated-change","changelog","changelog-generator","ci","ci-cd","deployment","github","github-pages","npm","registry","release","release-automation","release-notes","version","version-control","versioning"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/semantic-release-config-conventional","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abelflopes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-28T09:07:05.000Z","updated_at":"2024-03-07T01:26:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"93ebdf65-828a-4921-bb7e-6811811609cf","html_url":"https://github.com/abelflopes/semantic-release-config-conventional","commit_stats":null,"previous_names":["abelflopes/semantic-release-config-conventional"],"tags_count":2,"template":false,"template_full_name":"abelflopes/typescript-library-template","purl":"pkg:github/abelflopes/semantic-release-config-conventional","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abelflopes%2Fsemantic-release-config-conventional","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abelflopes%2Fsemantic-release-config-conventional/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abelflopes%2Fsemantic-release-config-conventional/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abelflopes%2Fsemantic-release-config-conventional/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abelflopes","download_url":"https://codeload.github.com/abelflopes/semantic-release-config-conventional/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abelflopes%2Fsemantic-release-config-conventional/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31915900,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"online","status_checked_at":"2026-04-17T02:00:06.879Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["automated-change","changelog","changelog-generator","ci","ci-cd","deployment","github","github-pages","npm","registry","release","release-automation","release-notes","version","version-control","versioning"],"created_at":"2024-11-14T21:06:43.322Z","updated_at":"2026-04-17T05:02:25.781Z","avatar_url":"https://github.com/abelflopes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Semantic Release Conventional\n\n[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to publish npm packages with [GitHub](https://github.com) using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.\n\n## Features\n\n- Allow running dry run (release predict) on any branch\n- Commits are analyzed with conventional commits parser, configuration extended so that `refactor` \u0026 `style` types increase patch version\n- Release notes are generated and written to che changelog covering all the common commit types relevant to the consumer\n- Automatically generated changelog\n- Publishes to a npm package registry\n- Creates a Github release\n- Pushes `package.json` and `CHANGELOG.md` file to git\n\n## Installation\n\nYou can install this config via npm or yarn:\n\n```bash\nnpm install semantic-release-config-conventional --save-dev\n# or\nyarn add semantic-release-config-conventional --dev\n```\n\n## Usage\n\nThe shareable config can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):\n\nTo use this configuration in your project, create a Prettier configuration file\n(e.g., .prettierrc.js) and extend `semantic-release-config-conventional`:\n\n```js\n// .releaserc.js\n\nmodule.exports = {\n    extends: \"semantic-release-config-conventional\"\n};\n```\n\n### Configuration\n\nThis config can be provided with some options through environment variables\n\n```js\n// .releaserc.js\n\nprocess.env.SR_CONFIG_NPM_PUBLISH = \"false\"; // if set to false will not attempt to publish a package to the registry\nprocess.env.SR_CONFIG_NPM_PUSH = \"true\"; // if set to false will disable pushing of the package.json and changelog files after releasing\nprocess.env.SR_CONFIG_CHANGELOG_FILE = \"CHANGELOG.md\"; // defines the path for the changelog file\n\nmodule.exports = {\n    extends: \"semantic-release-config-conventional\"\n};\n```\n\nSee each [plugin](#plugins) documentation for required installation and configuration steps.\n\n## Plugins\n\nThis shareable configuration uses the following plugins (with [internal configurations](https://github.com/abelflopes/semantic-release-config-conventional/blob/master/src/index.ts) applied):\n\n- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)\n- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)\n- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)\n- [`@semantic-release/npm`](https://github.com/semantic-release/npm)\n- [`@semantic-release/github`](https://github.com/semantic-release/github)\n- [`@semantic-release/git`](https://github.com/semantic-release/git)\n\n## Additional Recommended Setup\n\nFor optimal experience and consistency with sematic release, it is suggested to add commit validation matching the standard applied to semantic-release, in this case `conventional-commits`.\n\nIdeally the releases should be performed through CI/CD workflows, reducing the possibility of human error. The commit validation should also run on the CI/CD workflows.\n\nCheck the [example/recipe](https://github.com/abelflopes/semantic-release-config-conventional/tree/master/docs/example).\n\n## Contributing\n\nIf you encounter any issues with this ESLint configuration or have suggestions for improvements,\nplease visit the GitHub repository and open an issue or pull request.\nCheck also the [development](./docs/DEVELOPMENT.md) docs.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabelflopes%2Fsemantic-release-config-conventional","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabelflopes%2Fsemantic-release-config-conventional","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabelflopes%2Fsemantic-release-config-conventional/lists"}