{"id":18521826,"url":"https://github.com/transferwise/release-to-github-with-changelog","last_synced_at":"2025-08-07T23:19:26.525Z","repository":{"id":9712781,"uuid":"63079265","full_name":"transferwise/release-to-github-with-changelog","owner":"transferwise","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-02T12:23:44.000Z","size":1986,"stargazers_count":4,"open_issues_count":6,"forks_count":5,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-07-22T15:43:35.494Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/transferwise.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2016-07-11T15:23:22.000Z","updated_at":"2022-05-27T07:17:28.000Z","dependencies_parsed_at":"2024-06-19T09:16:15.309Z","dependency_job_id":"ae57552a-2175-4e2c-ab25-ede38ef54335","html_url":"https://github.com/transferwise/release-to-github-with-changelog","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/transferwise/release-to-github-with-changelog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Frelease-to-github-with-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Frelease-to-github-with-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Frelease-to-github-with-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Frelease-to-github-with-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/transferwise","download_url":"https://codeload.github.com/transferwise/release-to-github-with-changelog/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Frelease-to-github-with-changelog/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269338501,"owners_count":24400292,"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","status":"online","status_checked_at":"2025-08-07T02:00:09.698Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2024-11-06T17:27:47.012Z","updated_at":"2025-08-07T23:19:26.481Z","avatar_url":"https://github.com/transferwise.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# release-to-github-with-changelog\n[![npm version](https://badge.fury.io/js/release-to-github-with-changelog.svg)](https://badge.fury.io/js/release-to-github-with-changelog)\n\n*Node v6.9.1 is required*\n\n## Goal\nKeep the released npm package in sync with the GitHub repo master branch:\n- the last `CHANGELOG.md` item is in sync with the last release on Github, with corresponding version tag\n- the `package.json` version is in sync with the `master` branch version tag\n\n![alt tag](img/changelog_releases_sync.png)\n\n## Usage\nThe sources of truth are `CHANGELOG.md` and `package.json`.\nYour interface is your `CHANGELOG.md`.\n### CHANGELOG.md\nEvery `CHANGELOG.md` item should represent a release note of the version it describes:\n```\n# v0.2.0 //version tag\n## The release title\n// The release description in markdown\n\n# v0.1.9\n...\n```\n#### Full example:\n```\n# v0.2.0\n## We can fly\nGreat news! The machine can now also fly!\n\n# v0.1.0\n## We can move\n### What the machine does\nIt can move, a bit slowly but still it moves.\n\n//...\n```\n### Export a GITHUB_TOKEN env variable\nEither locally with `export GITHUB_TOKEN=$yourToken` or in your CI tool settings (see CircleCI example).\n\n### Example of package.json\nDon't forget the `repository.url`. It will be parsed to extract the repository full name (`myOrg/myRepo` in this example).\n#### Test tool\nYou can include a check of your `CHANGELOG.md` format in your test command by using the provided `release-to-github-with-changelog-pre-release-checks` command.\n```\n{\n  \"version\": \"0.2.0\",\n  \"respository\": {\n    \"type\": \"git\",\n    \"url\": \"git+https://github.com/myOrg/myRepo.git\"\n  },\n  \"files\": [\"dist\"],\n  \"scripts\": {\n    \"build\": // build dist files\n    \"release\": \"npm publish \u0026\u0026 npm run release-to-github-with-changelog\",\n    \"release\": \"npm publish \u0026\u0026 npm run release-to-github-with-changelog --branch=releases\", // optional branch name\n    \"test\": \"release-to-github-with-changelog-pre-release-checks \u0026\u0026 karma start\"\n  }\n}\n```\n## CI example\n`circle.yml`\n```\nmachine:\n  node:\n    version: 4.1.0\ndependencies:\n  pre:\n    - echo -e \"$NPM_USER\\n$NPM_PASS\\n$NPM_EMAIL\" | npm login\ndeployment:\n  production:\n    branch: master\n    commands:\n      - npm run release\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransferwise%2Frelease-to-github-with-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftransferwise%2Frelease-to-github-with-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransferwise%2Frelease-to-github-with-changelog/lists"}