{"id":23335315,"url":"https://github.com/janszewczyk/semantic-release-config","last_synced_at":"2026-03-12T07:35:09.054Z","repository":{"id":86386605,"uuid":"606537800","full_name":"JanSzewczyk/semantic-release-config","owner":"JanSzewczyk","description":"Semantic-release shareable configuration to publish GitHub projects using GitHub Actions workflows.","archived":false,"fork":false,"pushed_at":"2025-03-09T20:20:20.000Z","size":445,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-23T21:35:49.136Z","etag":null,"topics":["conventional-changelog","github","github-publish","npm","npm-publish","release","semantic-release","semantic-release-config","semantic-release-preset","szum-tech"],"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/JanSzewczyk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-02-25T19:41:56.000Z","updated_at":"2025-03-02T22:37:31.000Z","dependencies_parsed_at":"2024-11-29T19:17:13.226Z","dependency_job_id":null,"html_url":"https://github.com/JanSzewczyk/semantic-release-config","commit_stats":{"total_commits":22,"total_committers":2,"mean_commits":11.0,"dds":0.2727272727272727,"last_synced_commit":"3fc253fd4d15c8b4ef7dce0a07465b80a104eeee"},"previous_names":["janszewczyk/semantic-release-config","janszewczyk/semantic-release-preset"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JanSzewczyk%2Fsemantic-release-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JanSzewczyk%2Fsemantic-release-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JanSzewczyk%2Fsemantic-release-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JanSzewczyk%2Fsemantic-release-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JanSzewczyk","download_url":"https://codeload.github.com/JanSzewczyk/semantic-release-config/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248100374,"owners_count":21047783,"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":["conventional-changelog","github","github-publish","npm","npm-publish","release","semantic-release","semantic-release-config","semantic-release-preset","szum-tech"],"created_at":"2024-12-21T01:18:56.656Z","updated_at":"2025-04-09T19:41:10.848Z","avatar_url":"https://github.com/JanSzewczyk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e@szum-tech/semantic-release-config\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://semantic-release.gitbook.io/semantic-release\"\u003eSemantic-release\u003c/a\u003e shareable configuration.\u003c/p\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\" style=\"display: flex; flex-direction: column; gap: 1em;\"\u003e\n    \u003cdiv style=\"display: flex; gap: .5em; justify-content: center\"\u003e\n        \u003ca href=\"https://github.com/JanSzewczyk/semantic-release-config\"\u003e\u003cimg alt=\"GitHub Release\" src=\"https://img.shields.io/github/v/release/JanSzewczyk/semantic-release-config\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/JanSzewczyk/semantic-release-config/pulls\"\u003e\u003cimg alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/JanSzewczyk/semantic-release-config\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/JanSzewczyk/semantic-release-config/issues\"\u003e\u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/JanSzewczyk/semantic-release-config\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/JanSzewczyk/semantic-release-config\"\u003e\u003cimg alt=\"Github stars\" src=\"https://img.shields.io/github/stars/JanSzewczyk/semantic-release-config?style=social\"\u003e\u003c/a\u003e\n    \u003c/div\u003e\n    \u003cdiv style=\"display: flex; gap: .5em; justify-content: center\"\u003e\n        \u003ca href=\"https://github.com/JanSzewczyk/semantic-release-config/actions/workflows/publish.yml\"\u003e\u003cimg alt=\"Publish action\" src=\"https://github.com/JanSzewczyk/semantic-release-config/actions/workflows/publish.yml/badge.svg?branch=main\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/JanSzewczyk/semantic-release-config/actions/workflows/codeql.yml\"\u003e\u003cimg alt=\"CodeQL action\" src=\"https://github.com/JanSzewczyk/semantic-release-config/actions/workflows/codeql.yml/badge.svg\"\u003e\u003c/a\u003e\n    \u003c/div\u003e\n    \u003cdiv style=\"display: flex; gap: .5em; justify-content: center\"\u003e\n        \u003ca href=\"https://www.npmjs.com/package/@szum-tech/semantic-release-config\"\u003e\u003cimg alt=\"NPM version\" src=\"https://img.shields.io/npm/v/@szum-tech/semantic-release-config\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://www.npmjs.com/package/@szum-tech/semantic-release-config\"\u003e\u003cimg alt=\"Downloads\" src=\"https://img.shields.io/npm/dm/@szum-tech/semantic-release-config\"\u003e\u003c/a\u003e\n    \u003c/div\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\n    Setting up a Semantic-release configuration should be easier.\n    \u003cbr/\u003e\n    \u003ca href=\"https://semantic-release.gitbook.io/semantic-release\"\u003eSemantic-release\u003c/a\u003e shareable configuration to publish GitHub projects using GitHub Actions workflows.\n\u003c/p\u003e\n\n---\n\n## 📚 Features\n\n- Uses [Conventional Commits](https://www.conventionalcommits.org/) to generate\n  [release notes](https://github.com/semantic-release/release-notes-generator),\n  [changelogs](https://github.com/semantic-release/changelog) and\n  [determine the version for new releases](https://github.com/semantic-release/commit-analyzer).\n- [Creates or updates a CHANGELOG.md file](https://github.com/semantic-release/changelog).\n- [Publishes to npm (optional)](https://github.com/semantic-release/npm).\n- [Creates a new release on GitHub](https://github.com/semantic-release/github).\n- [Updates GitHub issues and PRs that are resolved by a new release](https://github.com/semantic-release/github#successcomment).\n- [Commits and pushes the current `version` to `package.json`](https://github.com/semantic-release/git).\n- Offers predefined configurations or configuration builder function\n\n## 📖 Table of Contents\n\n\u003c!-- TOC --\u003e\n  * [📚 Features](#-features)\n  * [📖 Table of Contents](#-table-of-contents)\n  * [🎯 Getting Started](#-getting-started)\n    * [⚙️ Installation](#-installation)\n    * [Configuration](#configuration)\n      * [Predefined configs](#predefined-configs)\n      * [Configuration Builder](#configuration-builder)\n  * [💻 Environment Variables Configuration](#-environment-variables-configuration)\n  * [🚀 Minimal GitHub Release workflow](#-minimal-github-release-workflow)\n  * [🛠️ Developer Info](#-developer-info)\n    * [Dependencies](#dependencies)\n  * [📓 Changelog](#-changelog)\n  * [📜 License](#-license)\n\u003c!-- TOC --\u003e\n\n## 🎯 Getting Started\n\n### ⚙️ Installation\n\n[@szum-tech/semantic-release-config](https://www.npmjs.com/package/@szum-tech/semantic-release-config) is available as\nan [npm package](https://www.npmjs.com/package/@szum-tech/semantic-release-config).\n\n```shell\n# NPM\nnpm install --save-dev semantic-release @szum-tech/semantic-release-config\n\n# YARN\nyarn add -D semantic-release @szum-tech/semantic-release-config\n\n# PNPM\npnpm add --save-dev semantic-release @szum-tech/semantic-release-config\n\n# BUN\nbun add --dev semantic-release @szum-tech/semantic-release-config\n```\n\n### Configuration\n\nBasic information needed to understand, how to set up semantic-release configuration, you are able to find under\n[USAGE \u003e Configuration](https://semantic-release.gitbook.io/semantic-release/usage/configuration) in `semantic-release`\ndocumentation.\n\n#### Predefined configs\n\n- `without-npm` - `@szum-tech/semantic-release-config/without-npm` - allows you to perform the code release process,\n  excluding publishing the code to npm\n- `with-npm` - `@szum-tech/semantic-release-config/with-npm` - allows you to perform the code release process, including\n  publishing the code to npm\n\n**Predefined configurations could be set via either:**\n\n- A `.releaserc` file, written in YAML or JSON, with optional extensions: `.yaml`/`.yml`/`.json`/`.js`/`.cjs`/`.mjs`\n- A `release.config.(js|cjs|.mjs)` file that exports an object\n- A `release` key in the project's `package.json` file\n\n**The following examples show how to integrate predefined configuration in project:**\n\n- Via `release.config.mjs` file:\n\n```js\nexport { default } from \"@szum-tech/semantic-release-config/with-npm\";\n// OR\n// export { config } from \"@szum-tech/semantic-release-config/without-npm\";\n// if you don't want to publish your project on npm\n```\n\nImported configurations also could be used to extends yours:\n\n```js\n/**\n * @type {import('semantic-release').GlobalConfig}\n */\nexport default {\n  branches: [\"master\", \"next\"],\n  extends: \"@szum-tech/semantic-release-config/with-npm\"\n  // OR\n  // extends: \"@szum-tech/semantic-release-config/without-npm\";\n  // if you don't want to publish your project on npm\n};\n```\n\n- Via `release.config.cjs` file:\n\n```js\nmodule.exports = require(\"@szum-tech/semantic-release-config/with-npm\");\n// OR\n// module.exports = required(\"@szum-tech/semantic-release-config/without-npm\");\n// if you don't want to publish your project on npm\n```\n\nOR extend configuration\n\n```js\n/**\n * @type {import('semantic-release').GlobalConfig}\n */\nmodule.exports = {\n  branches: [\"master\", \"next\"],\n  extends: \"@szum-tech/semantic-release-config/with-npm\"\n  // OR\n  // extends: \"@szum-tech/semantic-release-config/without-npm\";\n  // if you don't want to publish your project on npm\n};\n```\n\n- Via `release` key in the project's `package.json` file:\n\n```json\n{\n  \"release\": {\n    \"extends\": \"@szum-tech/semantic-release-config/with-npm\"\n    // OR\n    //  \"extends\": \"@szum-tech/semantic-release-config/without-npm\";\n    // if you don't want to publish your project on npm\n  }\n}\n```\n\n- Via `.releaserc` file:\n\n```json\n{\n  \"extends\": \"@szum-tech/semantic-release-config/with-npm\"\n  // OR\n  //  \"extends\": \"@szum-tech/semantic-release-config/without-npm\";\n  // if you don't want to publish your project on npm\n}\n```\n\n#### Configuration Builder\n\n`@szum-tech/semantic-release-config` also returns the `getConfig` function:\n\n```js\n// For *.mjs\nimport { getConfig } from \"@szum-tech/semantic-release-config\";\n\n// For *.cjs\nconst { getConfig } = require(\"@szum-tech/semantic-release-config\");\n```\n\nThis function takes an argument `configurationOptions`, where the is located `features` variable - defining configurable\nfeatures.\n\n**Features Table**\n\n| Name |                Description                |  Type   | Default Value |\n| :--: | :---------------------------------------: | :-----: | :-----------: |\n| npm  | Defined if release will be publish on npm | Boolean |     false     |\n\n**The following examples show how to integrate configuration builder function in project:**\n\n- Via `release.config.mjs` file:\n\n```js\nimport { getConfig } from \"@szum-tech/semantic-release-config\";\n\nexport default getConfig({ features: { npmPublish: true } });\n```\n\n- Via `release.config.cjs` file:\n\n```js\nconst { getConfig } = require(\"@szum-tech/semantic-release-config\");\n\nmodule.exports = getConfig({ features: { npmPublish: true } });\n```\n\n## 💻 Environment Variables Configuration\n\nEnsure that your CI configuration has the following environment variables set:\n\n- GITHUB_TOKEN:\n  [A GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)\n- NPM_TOKEN: [A npm personal access token](https://www.npmjs.com/package/settings) (**optional** if you don't publish\n  your project on npm)\n\n## 🚀 Minimal GitHub Release workflow\n\nThis is the bare minimum required steps to trigger a new release. This will push a new release every time an eligible\ncommit is pushed to git. Check the opinionated flow to see how to trigger releases manually. Create\n`.github/workflows/publish.yml`:\n\n```yaml\nname: Publish 🚀\n\non:\n  push:\n    branches: [main]\n\nenv:\n  NODE_VERSION: 22.x\n\njobs:\n  publish:\n    name: Publish 🚀\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout code 📚\n        uses: actions/checkout@v4\n      - name: Set up Node 🟢\n        uses: actions/setup-node@v4\n        with:\n          node-version: ${{ env.NODE_VERSION }}\n          cache: \"npm\"\n      - name: Install packages ⚙️\n        run: npm ci\n      - name: Build 🏗️\n        run: npm run build\n      - name: Publish package 🚀\n        run: npx semantic-release\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n```\n\n\u003e [!TIP]\n\u003e See also [publish.yml](https://github.com/JanSzewczyk/semantic-release-config/blob/main/.github/workflows/publish.yml) file.\n\n## 🛠️ Developer Info\n\n### Dependencies\n\n![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/%40szum-tech%2Fsemantic-release-config/%40semantic-release%2Fchangelog)\n![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/%40szum-tech%2Fsemantic-release-config/%40semantic-release%2Fcommit-analyzer)\n![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/%40szum-tech%2Fsemantic-release-config/%40semantic-release%2Fgit)\n![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/%40szum-tech%2Fsemantic-release-config/%40semantic-release%2Fgithub)\n![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/%40szum-tech%2Fsemantic-release-config/%40semantic-release%2Fnpm)\n![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/%40szum-tech%2Fsemantic-release-config/%40semantic-release%2Frelease-notes-generator)\n![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/%40szum-tech%2Fsemantic-release-config/conventional-changelog-conventionalcommits)\n\n## 📓 Changelog\n\nThe [changelog](https://github.com/JanSzewczyk/semantic-release-config/blob/main/CHANGELOG.md) is regularly updated to\nreflect what's changed in each new release.\n\n## 📜 License\n\nThis project is licensed under the terms of the\n[MIT license](https://github.com/JanSzewczyk/semantic-release-config/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanszewczyk%2Fsemantic-release-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjanszewczyk%2Fsemantic-release-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanszewczyk%2Fsemantic-release-config/lists"}