{"id":13561896,"url":"https://github.com/sindresorhus/new-github-release-url","last_synced_at":"2025-04-04T18:06:07.873Z","repository":{"id":55415166,"uuid":"160057087","full_name":"sindresorhus/new-github-release-url","owner":"sindresorhus","description":"Generate a URL for opening a new GitHub release with prefilled tag, body, and other fields","archived":false,"fork":false,"pushed_at":"2023-08-31T16:02:04.000Z","size":10,"stargazers_count":121,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-24T21:29:17.657Z","etag":null,"topics":["github","github-releases","npm-package","release-automation","url"],"latest_commit_sha":null,"homepage":"","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/sindresorhus.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":".github/security.md","support":null,"governance":null},"funding":{"github":"sindresorhus","open_collective":"sindresorhus","custom":"https://sindresorhus.com/donate"}},"created_at":"2018-12-02T14:43:47.000Z","updated_at":"2025-01-07T20:11:37.000Z","dependencies_parsed_at":"2022-08-14T23:50:38.279Z","dependency_job_id":null,"html_url":"https://github.com/sindresorhus/new-github-release-url","commit_stats":{"total_commits":10,"total_committers":3,"mean_commits":"3.3333333333333335","dds":"0.19999999999999996","last_synced_commit":"b8d237e442dae95c3b9af0575bf31b07e002fcfc"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fnew-github-release-url","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fnew-github-release-url/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fnew-github-release-url/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fnew-github-release-url/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sindresorhus","download_url":"https://codeload.github.com/sindresorhus/new-github-release-url/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246597821,"owners_count":20802970,"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":["github","github-releases","npm-package","release-automation","url"],"created_at":"2024-08-01T13:01:02.347Z","updated_at":"2025-04-04T18:06:07.854Z","avatar_url":"https://github.com/sindresorhus.png","language":"JavaScript","readme":"# new-github-release-url\n\n\u003e Generate a URL for opening a new GitHub release with prefilled tag, body, and other fields\n\nGitHub supports prefilling a new release by setting [certain search parameters](https://github.com/isaacs/github/issues/1410#issuecomment-442240267). This package simplifies generating such URL.\n\n## Install\n\n```sh\n$ npm install new-github-release-url\n```\n\n## Usage\n\n```js\nimport newGithubReleaseUrl from 'new-github-release-url';\nimport open from 'open';\n\nconst url = newGithubReleaseUrl({\n\tuser: 'sindresorhus',\n\trepo: 'new-github-release-url',\n\tbody: '\\n\\n\\n---\\nI\\'m a human. Please be nice.'\n});\n//=\u003e 'https://github.com/sindresorhus/new-github-release-url/releases/new?body=%0A%0A%0A---%0AI%27m+a+human.+Please+be+nice.'\n\n// Then open it\nawait open(url);\n```\n\n## API\n\n### newGithubReleaseUrl(options)\n\nReturns a URL string.\n\n#### options\n\nType: `object`\n\nYou are required to either specify the `repoUrl` option or both the `user` and `repo` options.\n\n##### repoUrl\n\nType: `string`\n\nThe full URL to the repo.\n\n##### user\n\nType: `string`\n\nGitHub username or organization.\n\n##### repo\n\nType: `string`\n\nGitHub repo.\n\n##### tag\n\nType: `string`\n\nThe tag name of the release.\n\n##### target\n\nType: `string`\\\nDefault: The default branch\n\nThe branch name or commit SHA to point the release's tag at, if the tag doesn't already exist.\n\n##### title\n\nType: `string`\n\nThe title of the release.\n\nGitHub shows the `tag` name when not specified.\n\n##### body\n\nType: `string`\n\nThe description text of the release.\n\n##### isPrerelease\n\nType: `boolean`\\\nDefault: `false`\n\nWhether the release should be marked as a pre-release.\n\n## Related\n\n- [new-github-issue-url](https://github.com/sindresorhus/new-github-issue-url) - Generate a URL for opening a new GitHub issue with prefilled title, body, and other fields\n","funding_links":["https://github.com/sponsors/sindresorhus","https://opencollective.com/sindresorhus","https://sindresorhus.com/donate"],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsindresorhus%2Fnew-github-release-url","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsindresorhus%2Fnew-github-release-url","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsindresorhus%2Fnew-github-release-url/lists"}