{"id":13465048,"url":"https://github.com/javascript-studio/studio-changes","last_synced_at":"2025-03-18T05:19:52.636Z","repository":{"id":14732209,"uuid":"66400186","full_name":"javascript-studio/studio-changes","owner":"javascript-studio","description":"📦 Generate a changelog as part of the npm version command","archived":false,"fork":false,"pushed_at":"2023-12-24T11:30:23.000Z","size":409,"stargazers_count":49,"open_issues_count":9,"forks_count":7,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-08-08T17:17:29.608Z","etag":null,"topics":["automation","changelog","commits","git","npm","release","versioning"],"latest_commit_sha":null,"homepage":"https://medium.com/javascript-studio/nice-and-easy-module-releases-a32c906b564e","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/javascript-studio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.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}},"created_at":"2016-08-23T20:18:57.000Z","updated_at":"2023-10-17T09:05:52.000Z","dependencies_parsed_at":"2024-01-16T05:42:14.702Z","dependency_job_id":"3be6a516-6461-41e9-9209-202e99b3ca0c","html_url":"https://github.com/javascript-studio/studio-changes","commit_stats":{"total_commits":126,"total_committers":7,"mean_commits":18.0,"dds":"0.15873015873015872","last_synced_commit":"45a62ad28f2249a2424f54310d7a1827177e44a7"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javascript-studio%2Fstudio-changes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javascript-studio%2Fstudio-changes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javascript-studio%2Fstudio-changes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javascript-studio%2Fstudio-changes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/javascript-studio","download_url":"https://codeload.github.com/javascript-studio/studio-changes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244160138,"owners_count":20408038,"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":["automation","changelog","commits","git","npm","release","versioning"],"created_at":"2024-07-31T14:00:56.093Z","updated_at":"2025-03-18T05:19:52.616Z","avatar_url":"https://github.com/javascript-studio.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  Studio Changes\n\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  📦 Generate a changelog as part of the \u003ca href=\"https://docs.npmjs.com/cli/version\"\u003enpm version command\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@studio/changes\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/@studio/changes.svg\" alt=\"npm Version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://semver.org\"\u003e\n    \u003cimg src=\"https://img.shields.io/:semver-%E2%9C%93-blue.svg\" alt=\"SemVer\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/javascript-studio/studio-changes/actions\"\u003e\n    \u003cimg src=\"https://github.com/javascript-studio/studio-changes/workflows/Build/badge.svg\" alt=\"Build Status\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-MIT-brightgreen.svg\" alt=\"License\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Usage\n\n- Use `npm version [patch|minor|major]` to create a release\n- Your editor will open with a generated `CHANGES.md` file\n- When you're done writing the release notes, save and close the editor to\n  continue\n- To abort the release, remove the heading with the new version number\n\n## Install\n\n```bash\n❯ npm install @studio/changes --save-dev\n```\n\n## Configure\n\n```bash\n❯ npx changes --init\n```\n\nThis will add the following to your `package.json`:\n\n```json\n{\n  \"scripts\": {\n    \"preversion\": \"npm test\",\n    \"version\": \"changes\",\n    \"postversion\": \"git push --follow-tags \u0026\u0026 npm publish\"\n  }\n}\n```\n\n## Options\n\n- `--help`, `-h`: Display a help message.\n- `--commits`, `-c`: Generate links to commits using the given URL as base. If\n  no URL is given it defaults to `${homepage}/commit` using the homepage\n  configured in the `package.json`.\n- `--footer`: Generate a footer with the git author and release date. The\n  author name is taken from `$GIT_AUTHOR_NAME` and `$GIT_AUTHOR_EMAIL` is used\n  to find the authors GitHub profile page.\n- `--file`, `-f`: Specify the name of the changelog file. Defaults to\n  `CHANGES.md`.\n- `--init`: Add version lifecycle scripts to `package.json`. Can be combined\n  with `--file` and `--commits` to configure the `changes` invocation.\n- `--tag`: Use a custom git tag, supports simple replacement of `package.json`\n  fields. Defaults to `v${version}`.\n- `--dir`: Passes the given dir to `git log -- \u003cdir\u003e` to filter the commit\n  history by this directory.\n- `--workspace`: Is a convenience flag which sets `--dir` to the current\n  directory name and `--tag` to `${dir}/v${version}`.\n\nConfigure your preferred editor with the `$EDITOR` environment variable.\n\n## Preview next release\n\nPreview the release notes for the next release by running:\n\n```bash\n❯ npx changes\n```\n\n![](https://javascript.studio/assets/changes-1.0.gif)\n\n## License\n\nMIT\n\n\u003cp align=\"center\"\u003eMade with ❤️ on 🌍\u003cp\u003e\n\n[1]: https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavascript-studio%2Fstudio-changes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjavascript-studio%2Fstudio-changes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavascript-studio%2Fstudio-changes/lists"}