{"id":17867951,"url":"https://github.com/unix/done","last_synced_at":"2025-03-21T10:32:36.146Z","repository":{"id":44598326,"uuid":"188557847","full_name":"unix/done","owner":"unix","description":"Releaser for semantic version.","archived":false,"fork":false,"pushed_at":"2023-06-29T16:45:36.000Z","size":83,"stargazers_count":9,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-10T18:11:19.919Z","etag":null,"topics":["command-line","release-helper","semver"],"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/unix.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":"2019-05-25T11:27:38.000Z","updated_at":"2023-09-13T18:46:30.000Z","dependencies_parsed_at":"2024-10-29T07:45:12.386Z","dependency_job_id":null,"html_url":"https://github.com/unix/done","commit_stats":{"total_commits":23,"total_committers":4,"mean_commits":5.75,"dds":0.3913043478260869,"last_synced_commit":"d90222e4033b9183da133e0dfed304aefd0e6f1e"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unix%2Fdone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unix%2Fdone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unix%2Fdone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unix%2Fdone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unix","download_url":"https://codeload.github.com/unix/done/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244135894,"owners_count":20403797,"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":["command-line","release-helper","semver"],"created_at":"2024-10-28T09:56:15.404Z","updated_at":"2025-03-21T10:32:35.894Z","avatar_url":"https://github.com/unix.png","language":"TypeScript","readme":"## done\n\n`done` is a command line tool to help standardize release.\n\njust run `npx done`.\n\n### Features\n\n- No dependencies. (15k ~gzip).\n- Support multiple remotes.\n- Support Hooks.\n- Faster running speed.\n\n### Usage\n\n`done` will help you automatically generate a release, follow [SemVer](https://semver.org/) spec.\n\n**Recommended use of NPX**. Please do not download this package. (required npm \u003e 5.2.0, [what is npx](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner).)\n\n```bash\nnpx done\n```\n![screenshot](screenshot.png)\n\neverything is done, it's easy, right?\n\n\n### Hooks\n`done` will look for a file named release.js in the root directory of your project.\n\n\n```js\n// release.js\nmodule.export = (meta: Release.HookMetas): string =\u003e {\n  if (meta.type === 'patch') {\n    return 'fix some bugs'\n  }\n  return meta.version\n}\n```\n\n**Hook params**:\n\n```ts\nexport interface ChangeInfo {\n  name: string,\n  pluralName: string,\n  description: string,\n}\n\nexport interface HookMetas {\n  infos: ChangeInfo,\n  type: string,\n  version: string,\n}\n```\n\n### Why\n\n- why use `npx` instead of install?\n    1. `done` very small and no dependences (published), the online experience is great.\n    2. make your computer cleaner.\n    3. conflict with `shell` reservations, if you must download to the global, try `DONE`.\n\n- why can't add files when release?\n    1. `done` jsut to help you add tags.\n    2. add files requires GitHub(or other) authentication.\n\n- why NPX is so fast?\n    1. i used `ncc` pack files, it worked amazingly well.\n    2. i use `arg` instead of `commander`.\n\n\u003cbr/\u003e\n\n### license\n[MIT](LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funix%2Fdone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funix%2Fdone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funix%2Fdone/lists"}