{"id":15022229,"url":"https://github.com/lencx/tauri-release","last_synced_at":"2025-04-12T06:17:14.508Z","repository":{"id":63980003,"uuid":"571385765","full_name":"lencx/tauri-release","owner":"lencx","description":"🔗 tauri release toolchain","archived":false,"fork":false,"pushed_at":"2024-04-28T03:15:04.000Z","size":4944,"stargazers_count":20,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-12T06:17:04.701Z","etag":null,"topics":["action","cli","github-action","tauri-apps","tauri-release"],"latest_commit_sha":null,"homepage":"","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/lencx.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-11-28T02:16:47.000Z","updated_at":"2025-01-14T15:43:44.000Z","dependencies_parsed_at":"2023-01-24T17:15:44.401Z","dependency_job_id":"5203420f-d9a1-4c9f-b4e7-cefe95553500","html_url":"https://github.com/lencx/tauri-release","commit_stats":{"total_commits":29,"total_committers":1,"mean_commits":29.0,"dds":0.0,"last_synced_commit":"41d89e44255d70aafd55eff2f446a9271dc668fe"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lencx%2Ftauri-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lencx%2Ftauri-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lencx%2Ftauri-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lencx%2Ftauri-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lencx","download_url":"https://codeload.github.com/lencx/tauri-release/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525141,"owners_count":21118620,"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":["action","cli","github-action","tauri-apps","tauri-release"],"created_at":"2024-09-24T19:57:40.315Z","updated_at":"2025-04-12T06:17:14.457Z","avatar_url":"https://github.com/lencx.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tauri-release\n\n\u003e 🔗 tauri release toolchain\n\n## [@tauri-release/cli](./packages/cli/README.md)\n\n[![npm](https://img.shields.io/npm/v/@tauri-release/cli.svg)](https://www.npmjs.com/package/@tauri-release/cli)\n[![npm downloads](https://img.shields.io/npm/dm/@tauri-release/cli.svg)](https://npmjs.org/package/@tauri-release/cli)\n[![node version](https://img.shields.io/badge/Node.js-^14.16.0-343434?style=flat\u0026labelColor=026e00)](https://nodejs.org/en/)\n\n*Note: `@tauri-release/cli` needs to be used with [Tauri GitHub Action](https://github.com/tauri-apps/tauri-action).*\n\n### Why you need `Tauri GitHub Action`?\n\nThe `@tauri-release/cli updater` subcommand need to read the zip information from the [github releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases), and use it as a data source for the [updater json](https://tauri.app/v1/guides/distribution/updater/#update-file-json-format) to automate the application updates.\n\n### Features\n\n- [new](#new)\n- [release](#release)\n- [updater](#updater)\n- [override](#override)\n\n*Note: `@tauri-release/cli` needs to be used with [Tauri GitHub Action](https://github.com/tauri-apps/tauri-action).*\n\n### Install\n\n```bash\n# Npm\nnpm i -D @tauri-release/cli\n\n# Yarn\nyarn add -D @tauri-release/cli\n\n# Pnpm\npnpm i -D @tauri-release/cli\n```\n\n### Usage\n\n```bash\n# long command\ntauir-release\n\n# short command\ntr\n\n# help\ntr -h\n```\n\n### subCommand\n\n#### release\n\n#### [[semver]](https://semver.org/)\n\nAutomatic version upgrade, the default value is `--patch`:\n\n- `major`\n- `minor`\n- `patch`\n\n```bash\n# 0.x.x -\u003e 1.x.x\ntr release --major\n\n# x.0.x -\u003e x.1.x\ntr release --minor\n\n# x.x.0 -\u003e x.x.1\ntr release\n```\n\n##### --git\n\nEnable the git command to automatically submit after the version is updated, create a tag and push it to the remote repository (`git add -\u003e git commit -\u003e git tag -\u003e git push`)\n\n```bash\n# default is not enabled\ntr release -major\n\n# enable\ntr release --major --git\n```\n\n##### --logfile\n\nCustomize the `update-log` file path, the default name is `UPDATE_LOG.md`.\n\n```bash\ntr release --git\n\n# custom file\ntr release --git --logfile=\"src/update_log.md\"\n```\n\n#### new\n\n##### log\n\nGenerate tauri update-log file, the default name is `UPDATE_LOG.md`.\n\n```bash\ntr new log\n\n# custom file\ntr new --logfile=\"src/update_log.md\"\n```\n\n##### action\n\nGenerate github action file, the default name is `.github/workflows/release.yml`.\n\n```bash\ntr new action\n\n# custom file\ntr new action --actionfile=\".github/workflows/tauri-release.yml\"\n```\n\n#### updater\n\nGenerate tauri update file, the default name is `updater/install.json`. [[Tauri doc] Update File JSON Format](https://tauri.app/v1/guides/distribution/updater/#update-file-json-format).\n\n```bash\ntr updater --owner=GITHUB_OWNER --repo=GITHUB_REPO --token=GITHUB_TOKEN\n\n# custom file\n# The notes field value in the json file needs to be obtained from the update_log file\ntr updater --owner=GITHUB_OWNER --repo=GITHUB_REPO --token=GITHUB_TOKEN --logfile=\"src/update_log.md\"\n```\n\n#### override\n\nOverride [productName or version](https://tauri.app/v1/api/config/#packageconfig) (`tauri.conf.json \u003e package`):\n\n##### --name\n\n```bash\n# package.productName\ntr override --name=TauriApp\n```\n\n##### --version\n\n```bash\n# package.version\ntr override --version=\"../package.json\"\n```\n\n#### --json.a_b_c\n\nAny field in any json file can be overwritten, the field cannot contain `_`.\n\n- key: `a_b_c -\u003e a.b.c`\n- value: `number | null | boolean | string`\n\n```bash\n# package_productName -\u003e package.productName\n# tauri_allowlist_all -\u003e tauri.allowlist.all\ntr override --json.package_productName=\"WA\" --json.tauri_allowlist_all=true\n```\n\n##### --jsonfile\n\nCustomize the `tauri.conf.json` path, the default is `src-tauri/tauri.conf.json` ([tauri.conf.json](https://tauri.app/v1/api/config/)).\n\n```bash\ntr override --name=\"hello-tauri\" --version=\"../package.json\" --jsonfile=\"src/path/tauri.conf.json\"\n\n# any field in any json file\n# a_b_c -\u003e a.b.c\n# b_c -\u003e b.c\ntr override --json.a_b_c=true --json.b_c=20 --jsonfile=\"test.json\"\n```\n\n### Examples\n\n[lencx/WA/package.json](https://github.com/lencx/WA/blob/main/package.json)\n\n```json\n{\n  \"scripts\": {\n    \"dev\": \"vite\",\n    \"build\": \"tsc \u0026\u0026 vite build\",\n    \"preview\": \"vite preview\",\n    \"tauri\": \"tauri\",\n    \"tr\": \"tr\",\n    \"updater\": \"tr updater\",\n    \"release\": \"tr release --git\",\n    \"fix:linux\": \"tr override --name=WA\"\n  },\n}\n```\n\n[lencx/WA/.github/workflows/release.yml](https://github.com/lencx/WA/blob/main/.github/workflows/release.yml)\n\n```yml\n# ...\n      - name: fix linux build\n        if: matrix.platform == 'ubuntu-latest'\n        run: |\n          yarn fix:linux\n\n# ...\n  updater:\n    runs-on: ubuntu-latest\n    needs: [create-release, build-tauri]\n\n    steps:\n      - uses: actions/checkout@v2\n      - run: yarn\n      - run: yarn updater --token=${{ secrets.GITHUB_TOKEN }}\n\n      - name: Deploy install.json\n        uses: peaceiris/actions-gh-pages@v3\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          publish_dir: ./updater\n          force_orphan: true\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flencx%2Ftauri-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flencx%2Ftauri-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flencx%2Ftauri-release/lists"}