{"id":28414724,"url":"https://github.com/jitsucom/monorel","last_synced_at":"2025-06-25T06:30:31.399Z","repository":{"id":37545652,"uuid":"505922767","full_name":"jitsucom/monorel","owner":"jitsucom","description":"An opinionated publishing tool for pnpm-based monorepos  ","archived":false,"fork":false,"pushed_at":"2023-10-23T19:23:55.000Z","size":42,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-03T20:08:24.475Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/jitsucom.png","metadata":{"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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-21T16:31:26.000Z","updated_at":"2023-07-21T22:08:15.000Z","dependencies_parsed_at":"2023-01-19T12:32:43.960Z","dependency_job_id":"8bc6a37d-e68e-44ed-81a9-158b183e430a","html_url":"https://github.com/jitsucom/monorel","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/jitsucom/monorel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jitsucom%2Fmonorel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jitsucom%2Fmonorel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jitsucom%2Fmonorel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jitsucom%2Fmonorel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jitsucom","download_url":"https://codeload.github.com/jitsucom/monorel/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jitsucom%2Fmonorel/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261818713,"owners_count":23214350,"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":[],"created_at":"2025-06-03T10:17:38.107Z","updated_at":"2025-06-25T06:30:31.376Z","avatar_url":"https://github.com/jitsucom.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Monorel\n\n`monorel` is an opinionated publishing tool for pnpm-based monorepos. Unlike peer projects — [changesets](https://github.com/changesets/changesets) or [auto](https://github.com/intuit/auto) `monorel` is designed to be as simple as possible. \n\n`monorel`:\n\n - Works only for `pnpm` based monorepos\n - Non-intrusive. The only change it makes is git tags. **Monorel never changes version in your code**\n - Do not requires configuration file. All options are exposed as cli parameters\n - Stable releases are manual, canary releases are automatic\n\n## Installation\n\n```\npnpm add -Dw monorel\n```\n\nRun this command in the workspace root\n\n## Usage\n\nAdd following scripts to your root `package.json`:\n\n```json\n{\n  \"scripts\": {\n    \"release\": \"monorel --npm-tag latest --filter './packages/a'  --filter './packages/b'\",\n    \"canary:publish\": \"monorel --filter './packages/a'  --filter './packages/b' --version '2.0.0-alpha.{rev}' --npm-tag canary --publish\"\n  }\n}\n```\n\nRun `pnpm release --version X.Y.Z` to dry run publishing of release version `X.Y.Z`. \nIf it looks good run `pnpm release:publish --version X.Y.Z --publish` to make a push to an `npm`\n\nRun `pnpm canary:publish` to publish a canary release. The release version will be `2.0.0.alpha.${sequentialNumber}`. The version \nwill be tagged with `canary` tag\n\n## Authorization best practices\n\n`monorel` relies on NPM registry authorization in current shell. It will fail if authorization is absent \n\nYou can check if you're authorized by running `pnpm whoami` in the same shell where you plan to run `monorel`.\n\nThere two ways to authorize yourself:\n - Run `pnpm login`. This method will work if you're making releases manually, but for running automatic releases throuh CI you will need a different \nmethod\n - Create `.npmrc`, add `//registry.npmjs.org/:_authToken=${NPM_TOKEN}` to the beginning and get a [NPM token](https://docs.npmjs.com/creating-and-viewing-access-tokens). Later\nyou could supply NPM_TOKEN to your CI tool for automated releases. But if you do that, *NPM will always look for `NPM_TOKEN`*. All commands (including `pnpm whoami`) will\nif NPM_TOKEN is undefined or invalid, even you successfully logger in with `pnpm login` before\n\nIf you're doing only manual releases, `pnpm login` will work just fine. But universal solution will be adding an auth instruction to `.npmrc`, and\ndefining NPM_TOKEN locally (example )\n\n\n\n## Parameters reference\n\n### `--version VERSION_PATTERN`\n\nVersion pattern. The end version will be a result of replacements of placeholders in VERSION_PATTERN. Placeholder expressions:\n\n* `{rev}` — sequiential revision numver\n* `{time}` — time as `20220601234501`\n\n### `--npm-tag TAG`\n\nNPM registry tag. Usually either `canary` or `latest`\n\n### `--git-tag TAG`\n\nGit tag pattern. By default it's `v{version}`.\n\n### `--push-tag`\n\nIf Git tag should be pushed to origin (default is `false`)\n\n### `--publish`\n\nUnless specified, monorel will do a dry run (meaning no actual publishing is done)\n\n### `--filter`\n\nSpecify a list of packages to apply publishing. Should follow [pnpm filtering syntax](https://pnpm.io/filtering)\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjitsucom%2Fmonorel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjitsucom%2Fmonorel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjitsucom%2Fmonorel/lists"}