{"id":16008014,"url":"https://github.com/ckerr/transmission-release-notes","last_synced_at":"2026-06-15T19:31:43.405Z","repository":{"id":138268853,"uuid":"571039350","full_name":"ckerr/transmission-release-notes","owner":"ckerr","description":null,"archived":false,"fork":false,"pushed_at":"2023-07-14T14:11:03.000Z","size":78,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-25T16:35:06.112Z","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/ckerr.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2022-11-27T00:22:18.000Z","updated_at":"2022-11-27T00:22:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"7837f662-4fab-47c4-8b65-919b73dc9a0b","html_url":"https://github.com/ckerr/transmission-release-notes","commit_stats":{"total_commits":47,"total_committers":1,"mean_commits":47.0,"dds":0.0,"last_synced_commit":"fee1a1854e37387e41f8de19759a493818e35026"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ckerr/transmission-release-notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckerr%2Ftransmission-release-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckerr%2Ftransmission-release-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckerr%2Ftransmission-release-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckerr%2Ftransmission-release-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ckerr","download_url":"https://codeload.github.com/ckerr/transmission-release-notes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckerr%2Ftransmission-release-notes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34377872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"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-10-08T12:23:06.414Z","updated_at":"2026-06-15T19:31:43.385Z","avatar_url":"https://github.com/ckerr.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# transmission-release-notes\n\nI'm putting this up to share with the others since we have a new beta coming Real Soon Now,\nbut for God's sake don't read the code. I've copied half of it from another project that I\nwrote a generator for and haven't done any reconciliation between the old and new code, nor\nany cleanup whatsoever, nor anything to make it easy to use. All it does -- barely -- is\ngenerate a draft version of release notes.\n\n## To use this current version:\n\n1. Set the environment variable `GITHUB_TOKEN` to a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) generated from the website. This will let you avoid rate limiting while the script scrapes GitHub.\n2. Set the environment variable `SRC_DIR` to point to the Transmission source directory (e.g. where the top-level CMakeLists.txt is)\n3. Clone this repo and install the deps with `npm install`\n4. Run with `npm start -- ` and append a range of git endpoints you're diffing between, and the name of the release to draft, e.g: `npm start -- 4.0.0-beta.1..main --version 4.0.0-beta.2`. This will scrape the GitHub data into a local cache.\n5. Run the render script and redirect the output to a file: `npm run render \u003e release-notes.md`\n\nExample use:\n\n```sh\n$ cd transmission-release-notes \u0026\u0026 npm install # setup\n$ rm -rf lib/.cache # only needed to pick up new changes, e.g. updated `Notes:` on GitHub\n$ GITHUB_TOKEN=redacted SRC_DIR=/path/to/transmission npm start -- 4.0.3..4.0.x --version=4.0.4\n$ cat lede | npm run --silent render -- --version=4.0.4 \u003e /tmp/notes.md\n$ npx vmd /tmp/notes.md\n```\n\nSo when preparing a release, keep editing PRs and repeat those last four lines until you're happy with `notes.md`.\n\n## Making better notes:\n\n- Org members can add give a release note to a PR by adding a comment (or by editing the PR body) with a paragraph that starts with `Notes: `. The rest of the text will be used as a summary for the change in the release notes.\n- Noteworthy changes should be given the label `notes:highlight`\n- Changes that shouldn't be in release notes should be given the label `notes:none` \n- Please capitalize the first word of the note, use past tense, and the sentence with a period. This is to make the collated notes more consistent and readable.\n- If there are several related PRs, try to give them the same `Notes:` summary so that they'll be grouped together.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fckerr%2Ftransmission-release-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fckerr%2Ftransmission-release-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fckerr%2Ftransmission-release-notes/lists"}