@ubic/release-it-config 0.1.3 → 0.1.4

package/README.md

@@ -4,47 +4,41 @@
 
 ## Требования
 
-- Node.js 20.\* [https://nodejs.org](https://nodejs.org/en/)
-- Yarn 4.\* [https://yarnpkg.com](https://yarnpkg.com/)
+- `release-it` 18 и новее. [https://github.com/release-it/release-it](https://github.com/release-it/release-it)
+- `@release-it/conventional-changelog` 10 и новее.\* [https://github.com/release-it/conventional-changelog](@release-it/conventional-changelog)
 
-## Скрипты
+## Установка
 
-```sh
-# запускает режим разработки
-yarn dev
-
-# собирает пакет для публикации
-yarn build
+Установить в проект конфиг и пакеты утилиты:
 
-# проверяет код на ошибки
-yarn lint
-
-# собирает пакет и запускает его в режиме production
-yarn start
+```
+yarn add -D release-it @release-it/conventional-changelog @ubic/release-it-config
 ```
 
-## Разработка
+## Настройка
 
-Используемый язык - typescript. В проекте используется esbuild для сборки. Разработка ведется внутри директории `/src`.
+Создать файл конфигурации `.release-it.ts` в корне проекта:
 
-> **Важно!** В итоговый бандл попадают только модули из файла `/src/index.ts`.
+```ts
+import { releaseItConfig } from '@ubic/release-it-config';
 
-## Сборка и публикация
+export default releaseItConfig;
+```
 
-В registry попадет только содержимое `/dist` + `package.json`, `README.md` и т.д.
-Пакет собирается в оба формата (CommonJS, ES Modules), и типы в отдельном d.ts файле.
+Добавить в package.json скрипт для релиза
 
-При сборке git-тега, он автоматически запушится в репозиторий. Публикация пакета происходит автоматически для каждого тега на уровне CI/CD в 2 registries ([NPM](https://www.npmjs.com/org/ubic), [Nexus](https://nexus.ubic.tech/#browse/browse:npm-hosted-front)).
+```sh
+npm pkg set scripts.release="release-it"
+```
 
-Для публикации **обязательно добавить в gitlab ENV**: `NEXUS_TOKEN`, `NPM_TOKEN`. В них должны содержаться access-токены для обоих registries. Получить их можно в профиле: [NPM](https://www.npmjs.com/) -> Profile -> Access Tokens, [Nexus](https://nexus.ubic.tech/#user/nugetapitoken). Если есть проблемы с токенами, обратись к мейнтейнеру репозитория.
+### Указание пути до файла конфига
 
-## Используемые технологии и инструменты
+При желании, можно изменить расположение файла конфига и указать его в скрипте:
 
-- [Typescript](https://www.typescriptlang.org/)
-- [esbuild](https://esbuild.github.io/)
-- [ESLint](https://eslint.org/)
-- [Prettier](https://prettier.io/)
-- [Commitlint](https://commitlint.js.org/)
-- [Vitest](https://vitest.dev/)
-- Git-hooks ([lint-staged](https://github.com/lint-staged/lint-staged) + [husky](https://typicode.github.io/husky/))
-- [GitLab](https://gitlab.com/)
+```json
+// package.json
+"scripts": {
+  // ...
+  "release": "release-it --config ./config/.release-it.ts"
+}
+```

package/dist/cjs/index.cjs

@@ -1 +1 @@
-"use strict";var n=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var g=(t,e)=>{for(var o in e)n(t,o,{get:e[o],enumerable:!0})},l=(t,e,o,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of p(e))!c.call(t,i)&&i!==o&&n(t,i,{get:()=>e[i],enumerable:!(r=a(e,i))||r.enumerable});return t};var m=t=>l(n({},"__esModule",{value:!0}),t);var u={};g(u,{releaseItConfig:()=>s});module.exports=m(u);var f={"@release-it/conventional-changelog":{preset:{name:"conventionalcommits",types:[{type:"feat",section:"\u0414\u043E\u0431\u0430\u0432\u043B\u0435\u043D\u043E"},{type:"fix",section:"\u0418\u0441\u043F\u0440\u0430\u0432\u043B\u0435\u043D\u043E"},{type:"chore",section:"\u041F\u0440\u043E\u0447\u0435\u0435"},{type:"refactor",section:"\u0420\u0435\u0444\u0430\u043A\u0442\u043E\u0440\u0438\u043D\u0433"},{type:"build",section:"\u0421\u0431\u043E\u0440\u043A\u0430"},{type:"docs",section:"\u0414\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u044F"},{type:"ci",section:"\u041D\u0430\u0441\u0442\u0440\u043E\u0439\u043A\u0430 CI/CD"},{type:"perf",section:"\u0423\u043B\u0443\u0447\u0448\u0435\u043D\u0438\u0435 \u043F\u0440\u043E\u0438\u0437\u0432\u043E\u0434\u0438\u0442\u0435\u043B\u044C\u043D\u043E\u0441\u0442\u0438"},{type:"test",section:"\u041F\u043E\u043A\u0440\u044B\u0442\u0438\u0435 \u0442\u0435\u0441\u0442\u0430\u043C\u0438"},{type:"style",section:"\u0423\u043B\u0443\u0447\u0448\u0435\u043D\u0438\u0435 \u0447\u0438\u0442\u0430\u0435\u043C\u043E\u0441\u0442\u0438 \u043A\u043E\u0434\u0430"}]},infile:"CHANGELOG.md",header:"# \u0418\u0441\u0442\u043E\u0440\u0438\u044F \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u0439",writerOpts:{groupBy:"type"},parserOpts:{mergePattern:/'Merge branch'/}}},s={git:{requireBranch:"master",requireUpstream:!0,requireCommits:!0,requireCleanWorkingDir:!1,addUntrackedFiles:!1,commitMessage:"chore(release): ${version}",tag:!0,tagName:"v${version}",push:!0},hooks:{"before:init":`git fetch --quiet && git merge-base --is-ancestor @{u} HEAD || { echo '\u274C \u0421\u043E\u0441\u0442\u043E\u044F\u043D\u0438\u0435 \u043B\u043E\u043A\u0430\u043B\u044C\u043D\u043E\u0433\u043E \u0440\u0435\u043F\u043E\u0437\u0438\u0442\u043E\u0440\u0438\u044F \u043D\u0435 \u0430\u043A\u0442\u0443\u0430\u043B\u044C\u043D\u043E, \u0432\u044B\u043F\u043E\u043B\u043D\u0438\u0442\u0435 "git pull".'; exit 1; }`},npm:{publish:!1},plugins:f};
+"use strict";var n=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var a=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var g=(t,e)=>{for(var o in e)n(t,o,{get:e[o],enumerable:!0})},l=(t,e,o,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of a(e))!c.call(t,i)&&i!==o&&n(t,i,{get:()=>e[i],enumerable:!(r=p(e,i))||r.enumerable});return t};var m=t=>l(n({},"__esModule",{value:!0}),t);var f={};g(f,{releaseItConfig:()=>s});module.exports=m(f);var u={"@release-it/conventional-changelog":{preset:{name:"conventionalcommits",types:[{type:"feat",section:"\u0414\u043E\u0431\u0430\u0432\u043B\u0435\u043D\u043E"},{type:"fix",section:"\u0418\u0441\u043F\u0440\u0430\u0432\u043B\u0435\u043D\u043E"},{type:"chore",section:"\u041F\u0440\u043E\u0447\u0435\u0435"},{type:"refactor",section:"\u0420\u0435\u0444\u0430\u043A\u0442\u043E\u0440\u0438\u043D\u0433"},{type:"build",section:"\u0421\u0431\u043E\u0440\u043A\u0430"},{type:"docs",section:"\u0414\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u044F"},{type:"ci",section:"\u041D\u0430\u0441\u0442\u0440\u043E\u0439\u043A\u0430 CI/CD"},{type:"perf",section:"\u0423\u043B\u0443\u0447\u0448\u0435\u043D\u0438\u0435 \u043F\u0440\u043E\u0438\u0437\u0432\u043E\u0434\u0438\u0442\u0435\u043B\u044C\u043D\u043E\u0441\u0442\u0438"},{type:"test",section:"\u041F\u043E\u043A\u0440\u044B\u0442\u0438\u0435 \u0442\u0435\u0441\u0442\u0430\u043C\u0438"},{type:"style",section:"\u0423\u043B\u0443\u0447\u0448\u0435\u043D\u0438\u0435 \u0447\u0438\u0442\u0430\u0435\u043C\u043E\u0441\u0442\u0438 \u043A\u043E\u0434\u0430"}]},infile:"CHANGELOG.md",header:"# \u0418\u0441\u0442\u043E\u0440\u0438\u044F \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u0439",writerOpts:{groupBy:"type"},parserOpts:{mergePattern:/'Merge branch'/}}},s={git:{requireBranch:"master",requireUpstream:!0,requireCommits:!0,requireCleanWorkingDir:!0,addUntrackedFiles:!1,commitMessage:"chore(release): ${version}",tag:!0,tagName:"v${version}",push:!0},hooks:{"before:init":`git fetch --quiet && git merge-base --is-ancestor @{u} HEAD || { echo '\u274C \u0421\u043E\u0441\u0442\u043E\u044F\u043D\u0438\u0435 \u043B\u043E\u043A\u0430\u043B\u044C\u043D\u043E\u0433\u043E \u0440\u0435\u043F\u043E\u0437\u0438\u0442\u043E\u0440\u0438\u044F \u043D\u0435 \u0430\u043A\u0442\u0443\u0430\u043B\u044C\u043D\u043E, \u0432\u044B\u043F\u043E\u043B\u043D\u0438\u0442\u0435 "git pull".'; exit 1; }`},npm:{publish:!1},plugins:u};

package/dist/esm/index.mjs

@@ -1 +1 @@
-var e={"@release-it/conventional-changelog":{preset:{name:"conventionalcommits",types:[{type:"feat",section:"\u0414\u043E\u0431\u0430\u0432\u043B\u0435\u043D\u043E"},{type:"fix",section:"\u0418\u0441\u043F\u0440\u0430\u0432\u043B\u0435\u043D\u043E"},{type:"chore",section:"\u041F\u0440\u043E\u0447\u0435\u0435"},{type:"refactor",section:"\u0420\u0435\u0444\u0430\u043A\u0442\u043E\u0440\u0438\u043D\u0433"},{type:"build",section:"\u0421\u0431\u043E\u0440\u043A\u0430"},{type:"docs",section:"\u0414\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u044F"},{type:"ci",section:"\u041D\u0430\u0441\u0442\u0440\u043E\u0439\u043A\u0430 CI/CD"},{type:"perf",section:"\u0423\u043B\u0443\u0447\u0448\u0435\u043D\u0438\u0435 \u043F\u0440\u043E\u0438\u0437\u0432\u043E\u0434\u0438\u0442\u0435\u043B\u044C\u043D\u043E\u0441\u0442\u0438"},{type:"test",section:"\u041F\u043E\u043A\u0440\u044B\u0442\u0438\u0435 \u0442\u0435\u0441\u0442\u0430\u043C\u0438"},{type:"style",section:"\u0423\u043B\u0443\u0447\u0448\u0435\u043D\u0438\u0435 \u0447\u0438\u0442\u0430\u0435\u043C\u043E\u0441\u0442\u0438 \u043A\u043E\u0434\u0430"}]},infile:"CHANGELOG.md",header:"# \u0418\u0441\u0442\u043E\u0440\u0438\u044F \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u0439",writerOpts:{groupBy:"type"},parserOpts:{mergePattern:/'Merge branch'/}}},t={git:{requireBranch:"master",requireUpstream:!0,requireCommits:!0,requireCleanWorkingDir:!1,addUntrackedFiles:!1,commitMessage:"chore(release): ${version}",tag:!0,tagName:"v${version}",push:!0},hooks:{"before:init":`git fetch --quiet && git merge-base --is-ancestor @{u} HEAD || { echo '\u274C \u0421\u043E\u0441\u0442\u043E\u044F\u043D\u0438\u0435 \u043B\u043E\u043A\u0430\u043B\u044C\u043D\u043E\u0433\u043E \u0440\u0435\u043F\u043E\u0437\u0438\u0442\u043E\u0440\u0438\u044F \u043D\u0435 \u0430\u043A\u0442\u0443\u0430\u043B\u044C\u043D\u043E, \u0432\u044B\u043F\u043E\u043B\u043D\u0438\u0442\u0435 "git pull".'; exit 1; }`},npm:{publish:!1},plugins:e};export{t as releaseItConfig};
+var e={"@release-it/conventional-changelog":{preset:{name:"conventionalcommits",types:[{type:"feat",section:"\u0414\u043E\u0431\u0430\u0432\u043B\u0435\u043D\u043E"},{type:"fix",section:"\u0418\u0441\u043F\u0440\u0430\u0432\u043B\u0435\u043D\u043E"},{type:"chore",section:"\u041F\u0440\u043E\u0447\u0435\u0435"},{type:"refactor",section:"\u0420\u0435\u0444\u0430\u043A\u0442\u043E\u0440\u0438\u043D\u0433"},{type:"build",section:"\u0421\u0431\u043E\u0440\u043A\u0430"},{type:"docs",section:"\u0414\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u044F"},{type:"ci",section:"\u041D\u0430\u0441\u0442\u0440\u043E\u0439\u043A\u0430 CI/CD"},{type:"perf",section:"\u0423\u043B\u0443\u0447\u0448\u0435\u043D\u0438\u0435 \u043F\u0440\u043E\u0438\u0437\u0432\u043E\u0434\u0438\u0442\u0435\u043B\u044C\u043D\u043E\u0441\u0442\u0438"},{type:"test",section:"\u041F\u043E\u043A\u0440\u044B\u0442\u0438\u0435 \u0442\u0435\u0441\u0442\u0430\u043C\u0438"},{type:"style",section:"\u0423\u043B\u0443\u0447\u0448\u0435\u043D\u0438\u0435 \u0447\u0438\u0442\u0430\u0435\u043C\u043E\u0441\u0442\u0438 \u043A\u043E\u0434\u0430"}]},infile:"CHANGELOG.md",header:"# \u0418\u0441\u0442\u043E\u0440\u0438\u044F \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u0439",writerOpts:{groupBy:"type"},parserOpts:{mergePattern:/'Merge branch'/}}},t={git:{requireBranch:"master",requireUpstream:!0,requireCommits:!0,requireCleanWorkingDir:!0,addUntrackedFiles:!1,commitMessage:"chore(release): ${version}",tag:!0,tagName:"v${version}",push:!0},hooks:{"before:init":`git fetch --quiet && git merge-base --is-ancestor @{u} HEAD || { echo '\u274C \u0421\u043E\u0441\u0442\u043E\u044F\u043D\u0438\u0435 \u043B\u043E\u043A\u0430\u043B\u044C\u043D\u043E\u0433\u043E \u0440\u0435\u043F\u043E\u0437\u0438\u0442\u043E\u0440\u0438\u044F \u043D\u0435 \u0430\u043A\u0442\u0443\u0430\u043B\u044C\u043D\u043E, \u0432\u044B\u043F\u043E\u043B\u043D\u0438\u0442\u0435 "git pull".'; exit 1; }`},npm:{publish:!1},plugins:e};export{t as releaseItConfig};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubic/release-it-config",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Standard release-it config for projects in ubic technologies",
   "repository": {
     "type": "git",
@@ -50,7 +50,8 @@
     "test:watch": "yarn vitest --watch=true",
     "prepare": "husky",
     "prepublishOnly": "yarn build",
-    "postversion": "git push --follow-tags"
+    "postversion": "node scripts/push-pre-tags.js",
+    "release": "release-it --config ./config/.release-it.ts"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.8.0",
@@ -59,7 +60,6 @@
     "@types/conventional-commits-parser": "^5.0.1",
     "@ubic/commitlint-config": "^1.0.4",
     "@ubic/eslint-config": "^7.0.0",
-    "conventional-changelog-conventionalcommits": "^7",
     "dts-bundle-generator": "^9.5.1",
     "esbuild": "^0.25.1",
     "eslint": "^9.22.0",